Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
JulienPeloton committed Jul 19, 2023
1 parent a47f718 commit f24c272
Showing 1 changed file with 22 additions and 6 deletions.
28 changes: 22 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,19 +19,35 @@
pip install fink-client --upgrade
```

You will also need to install `fastavro==1.6.0` separately (versions above are not compatible with alert schema):

```
# fastavro 1.6.1 requires Cython<3
pip install "Cython<3"
pip install --no-build-isolation "fastavro==1.6.0"
```

### Use or develop in a controlled environment

For usage:

```bash
git clone https://github.com/astrolabsoftware/fink-client.git
cd fink-client
conda env create -f environment.yml
conda env create -f https://raw.githubusercontent.com/astrolabsoftware/fink-client/master/environment.yml
conda activate fink-client
pip install "Cython<3"
pip install --no-build-isolation "fastavro==1.6.0"
pip install fink-client --upgrade
```

and then install it locally:
For development:

```bash
# install for development
git clone https://github.com/astrolabsoftware/fink-client.git
cd fink-client
conda env create -f environment.yml
conda activate fink-client
pip install "Cython<3"
pip install --no-build-isolation "fastavro==1.6.0"
pip install -e .
```

Expand Down Expand Up @@ -114,4 +130,4 @@ optional arguments:

```
More information at [docs/datatransfer](https://fink-broker.readthedocs.io/en/latest/services/data_transfer/).
More information at [docs/datatransfer](https://fink-broker.readthedocs.io/en/latest/services/data_transfer/).

0 comments on commit f24c272

Please sign in to comment.