Skip to content

Commit

Permalink
fixed setup and readme for PYPI
Browse files Browse the repository at this point in the history
  • Loading branch information
mehradans92 committed Dec 6, 2023
1 parent d2cd3c9 commit 087f31e
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 4 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/workflow.yml
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,6 @@ jobs:
pip install build
python -m build --sdist --wheel --outdir dist/ .
- name: Publish distribution 📦 to PyPI
uses: pypa/gh-action-pypi-publish@main
uses: pypa/gh-action-pypi-publish@master
with:
password: ${{ secrets.PYPI_API_TOKEN }}
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,13 +35,19 @@ Example 3: Thermal Conductivity of Metal-organic Frameworks
Installation
--------

```python
pip install Eunomia@git+https://github.com/AI4ChemS/Eunomia.git
```bash
pip install materials-eunomia
```

or you can clone the source code and install in developer mode:

```python
```bash
git clone https://github.com/AI4ChemS/Eunomia.git && cd Eunomia
pip install -e .
```

Cofirm correct installation by running the unittests:

```bash
cd tests && python -m unittest discover
```
1 change: 1 addition & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,4 @@ PyYAML
llama-index
unstructured
markdown
python-Levenshtein

0 comments on commit 087f31e

Please sign in to comment.