|
1 | | -# StochasticTree Python Package |
| 1 | +# StochasticTree Python Package Documentation |
2 | 2 |
|
3 | | -## Getting started |
4 | | - |
5 | | -The python package can be installed from source. Before you begin, make sure you have [conda](https://www.anaconda.com/download) installed. |
6 | | -Clone the repo recursively (including git submodules) by running |
7 | | - |
8 | | -```{bash} |
9 | | -git clone --recursive https://github.com/StochasticTree/stochtree-python.git |
10 | | -``` |
11 | | - |
12 | | -### Conda-based installation |
13 | | - |
14 | | -Conda provides a straightforward experience in managing python dependencies, avoiding version conflicts / ABI issues / etc. |
15 | | - |
16 | | -To build stochtree using a `conda` based workflow, first create and activate a conda environment with the requisite dependencies |
17 | | - |
18 | | -```{bash} |
19 | | -conda create -n stochtree-dev -c conda-forge python=3.10 numpy scipy pytest pandas pybind11 scikit-learn matplotlib seaborn |
20 | | -conda activate stochtree-dev |
21 | | -pip install jupyterlab |
22 | | -``` |
23 | | - |
24 | | -Then, navigate to the main `stochtree-python` project folder (i.e. `cd /path/to/stochtree-python`) and install the package locally via pip |
25 | | - |
26 | | -```{bash} |
27 | | -pip install . |
28 | | -``` |
29 | | - |
30 | | -### Pip-based installation |
31 | | - |
32 | | -If you would rather avoid installing and setting up conda, you can alternatively setup the dependencies and install `stochtree` using only `pip` (caveat: this has not been extensively tested |
33 | | -across platforms and python versions). |
34 | | - |
35 | | -First, navigate to the main `stochtree-python` project folder (i.e. `cd /path/to/stochtree-python`) and create and activate a virtual environment as a subfolder of the repo |
36 | | - |
37 | | -```{bash} |
38 | | -python -m venv venv |
39 | | -source venv/bin/activate |
40 | | -``` |
41 | | - |
42 | | -Install all of the package (and demo notebook) dependencies |
43 | | - |
44 | | -```{bash} |
45 | | -pip install numpy scipy pytest pandas scikit-learn pybind11 matplotlib seaborn jupyterlab |
46 | | -``` |
47 | | - |
48 | | -Then install stochtree via |
49 | | - |
50 | | -```{bash} |
51 | | -pip install . |
52 | | -``` |
| 3 | +This is documentation repository, which builds and publishes |
| 4 | +docs for the [stochtree python package](https://stochastictree.github.io/stochtree-python/). |
| 5 | +The source code for the python (and R and C++) is available at https://github.com/StochasticTree/stochtree |
0 commit comments