Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Updated README #48

Merged
merged 1 commit into from
Jun 18, 2024
Merged

Updated README #48

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 9 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,23 +45,25 @@ conda create -n stochtree-dev -c conda-forge python=3.10 numpy scipy pytest pand
conda activate stochtree-dev
```

Then, navigate to the main `stochtree-python` project folder (i.e. `cd /path/to/stochtree-python`) and install the package locally via pip
Then install the package from github via pip

```{bash}
pip install .
pip install git+https://github.com/StochasticTree/stochtree-cpp.git
```

(*Note*: if you'd also like to run the notebook examples in the `demo/` subfolder, you will also need jupyterlab, seaborn, and matplotlib)
(*Note*: if you'd also like to run `stochtree`'s notebook examples, you will also need jupyterlab, seaborn, and matplotlib)

```{bash}
conda install matplotlib seaborn
pip install jupyterlab
```

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

### Venv

You could also use venv for environment management. 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:
You could also use venv for environment management. First, navigate to the folder in which you usually store virtual environments
(i.e. `cd /path/to/envs`) and create and activate a virtual environment as a subfolder of the repo:

```{bash}
python -m venv venv
Expand All @@ -77,10 +79,10 @@ pip install numpy scipy pytest pandas scikit-learn pybind11
Then install stochtree via

```{bash}
pip install .
pip install git+https://github.com/StochasticTree/stochtree-cpp.git
```

(As above, if you'd like to run the notebook examples in the `demo/` subfolder, you will also need jupyterlab, seaborn, and matplotlib)
As above, if you'd like to run the notebook examples in the `demo/` subfolder, you will also need jupyterlab, seaborn, and matplotli and you will have to [clone the repo](###cloning-the-repository)

```{bash}
pip install matplotlib seaborn jupyterlab
Expand Down
Loading