Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
aymgal committed Jun 4, 2024
1 parent b661e1f commit e59455b
Showing 1 changed file with 13 additions and 5 deletions.
18 changes: 13 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,20 @@ See the [`example notebooks`](docs/notebooks) directory to generate and manipula

## Installation of the Python package

The easiest way to install the `coolest` Python package is via the `pip` installer:
### Latest released version

The easiest way to install the latest version of the `coolest` Python package is via PyPi:
```bash
# Activate your virtual environment before if needed

pip install coolest
```

### Latest development version

You can also install it from the GitHub repository directly to get access to the latest changes:
```bash
# clone the latest version
# Clone the latest version
git clone https://github.com/aymgal/COOLEST.git

# Move to the repo directly
Expand All @@ -58,9 +69,6 @@ pip install [-e] ".[opt]"

You can test the installation by running `python -c "import coolest"` in the terminal, or by running some of the example notebooks from the [documentation](docs/notebooks) directory. Moreover, you can run all unit tests (having `pytest` installed in your environment), with the command `pytest test`.

_There will be soon the possibility to install_ `coolest` _directly from PyPi and Conda._


## Contributing to the COOLEST standard

We encourage and highly value All types of feedback, feature proposals and contributions from the whole lensing community. Please have a look at [CONTRIBUTING.md](CONTRIBUTING.md) for more information about contributing to the project.
Expand Down

0 comments on commit e59455b

Please sign in to comment.