Skip to content

Commit c8ea1c2

Browse files
committed
Update README.md (Python) to incorporate pip installation instructions
1 parent b6e27c3 commit c8ea1c2

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,15 @@ Details on installation and use are available below:
1717

1818
# Python Package
1919

20+
## PyPI
21+
2022
The python package is not yet on PyPI but can be installed from source using pip's [git interface](https://pip.pypa.io/en/stable/topics/vcs-support/).
2123
To proceed, you will need a working version of [git](https://git-scm.com) and python 3.8 or greater (available from several sources, one of the most
2224
straightforward being the [anaconda](https://docs.conda.io/projects/conda/en/stable/user-guide/install/index.html) suite).
2325

24-
## Quick start
26+
## Development Version (Local Build)
27+
28+
### Quick start
2529

2630
Without worrying about virtual environments (detailed further below), `stochtree` can be installed from the command line
2731

@@ -30,11 +34,11 @@ pip install numpy scipy pytest pandas scikit-learn pybind11
3034
pip install git+https://github.com/StochasticTree/stochtree.git
3135
```
3236

33-
## Virtual environment installation
37+
### Virtual environment installation
3438

3539
Often, users prefer to manage different projects (with different package / python version requirements) in virtual environments.
3640

37-
### Conda
41+
#### Conda
3842

3943
Conda provides a straightforward experience in managing python dependencies, avoiding version conflicts / ABI issues / etc.
4044

@@ -60,7 +64,7 @@ pip install jupyterlab
6064

6165
With these dependencies installed, you can [clone the repo](###cloning-the-repository) and run the `demo/` examples.
6266

63-
### Venv
67+
#### Venv
6468

6569
You could also use venv for environment management. First, navigate to the folder in which you usually store virtual environments
6670
(i.e. `cd /path/to/envs`) and create and activate a virtual environment:

0 commit comments

Comments
 (0)