Skip to content

Commit

Permalink
docs: Update installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
r-leyshon committed Jul 9, 2024
1 parent b40994c commit 9d5377e
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 10 deletions.
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,19 +30,19 @@ Install Dependencies:

Package set-up and installation:

1. Setup a new conda env: `conda create -n r5py python=3.9.13`
1. Setup a new conda env: `conda create -n r5py python=3.11`
2. Activate the environment: `conda activate r5py`
3. Launch terminal and change directory to wherever you keep your GitHub repos: `cd ~/Documents`
4. Clone this repo, eg with https: `git clone https://github.com/datasciencecampus/transport-network-performance.git`
5. Change directory to the repo: `cd transport-network-performance`
6. Install pre-commit hooks: `pre-commit install`
7. Update pip: `pip install --upgrade pip`
8. Install r5py & other reqs: `pip install -r requirements.txt`
8. Install package & dependencies: `pip install -e '.[dev,test,docs]'`

Set-up check:

10. Run set-up pytests: `pytest --runsetup`.
11. If everything is working as expected, you should see some Java flavoured warnings about `--illegal-access` that you can ignore. But importantly look out for the message: `r5py has created the expected database files.`
10. Run `pytest --runinteg --runexpensive` to check test suite passes.
11. If everything is working as expected, you should see some Java flavoured warnings about `--illegal-access` that you can ignore. But importantly look out for any fails or errors in the pytest report.
12. If you've made it this far, you've earned yourself a coffee.

#### Dependencies
Expand Down
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,9 @@ We welcome contributions from others. Please check out our
## Installation
*Describe technical set-up. Such as the required dependencies.*

This package is designed to work with python 3.9.13. Full functionality is
tested on macos only. Other operating systems may be incompatible with
`transport_performance.osm` specifically.
This package is designed to work with python 3.9, 3.10 & 3.11. Full
functionality is tested on macos only. Other operating systems may be
incompatible with `transport_performance.osm` specifically.

The transport modelling features in `transport_performance.analyse_network`
depends upon a compatible Java Development Kit (JDK). Please consult the
Expand All @@ -63,15 +63,15 @@ or [venv](https://docs.python.org/3/library/venv.html).

With conda:
```
conda create -n transport-performance python=3.9.13 -y
conda create -n transport-performance python=3.11 -y
```
Once completed, activate the environment:
```
conda activate transport-performance
```
Install the python requirements:
Install the python package:
```
pip install -r requirements.txt
pip install .
```
Additional Java dependencies are required for full functionality. See the
[contributing guidance](./CONTRIBUTING.md) for assistance.
Expand Down

0 comments on commit 9d5377e

Please sign in to comment.