From c8ea1c2925293d1b9a78ee5a0925c80ce47ece0f Mon Sep 17 00:00:00 2001 From: Aleksander Molak Date: Wed, 10 Sep 2025 07:29:47 +0200 Subject: [PATCH 1/3] Update README.md (Python) to incorporate pip installation instructions --- README.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 36481f44..ec934777 100644 --- a/README.md +++ b/README.md @@ -17,11 +17,15 @@ Details on installation and use are available below: # Python Package +## PyPI + 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/). 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 straightforward being the [anaconda](https://docs.conda.io/projects/conda/en/stable/user-guide/install/index.html) suite). -## Quick start +## Development Version (Local Build) + +### Quick start Without worrying about virtual environments (detailed further below), `stochtree` can be installed from the command line @@ -30,11 +34,11 @@ pip install numpy scipy pytest pandas scikit-learn pybind11 pip install git+https://github.com/StochasticTree/stochtree.git ``` -## Virtual environment installation +### Virtual environment installation Often, users prefer to manage different projects (with different package / python version requirements) in virtual environments. -### Conda +#### Conda Conda provides a straightforward experience in managing python dependencies, avoiding version conflicts / ABI issues / etc. @@ -60,7 +64,7 @@ pip install jupyterlab With these dependencies installed, you can [clone the repo](###cloning-the-repository) and run the `demo/` examples. -### Venv +#### Venv 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: From 989cf6c0cec7f8f4fac9da9cb5b45ea7f0e82284 Mon Sep 17 00:00:00 2001 From: Aleksander Molak Date: Wed, 10 Sep 2025 07:32:43 +0200 Subject: [PATCH 2/3] Update README.md (Python) -> add pip installation instructions --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ec934777..271dbb12 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ Details on installation and use are available below: # Python Package -## PyPI +## PyPI (`pip`) 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/). 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 From ed63397a9e09f35567a2a50ac69b0985c6ece7c6 Mon Sep 17 00:00:00 2001 From: Aleksander Molak Date: Wed, 10 Sep 2025 07:37:55 +0200 Subject: [PATCH 3/3] Update README.md (Python) -> add pip installation instructions --- README.md | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 271dbb12..915c5fcd 100644 --- a/README.md +++ b/README.md @@ -19,12 +19,19 @@ Details on installation and use are available below: ## PyPI (`pip`) -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/). -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 -straightforward being the [anaconda](https://docs.conda.io/projects/conda/en/stable/user-guide/install/index.html) suite). +`stochtree`'s Python package can be installed from PyPI via: + +``` +pip install stochtree +``` ## Development Version (Local Build) +The development version of stochtree can be installed from source using pip's [git interface](https://pip.pypa.io/en/stable/topics/vcs-support/). + +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 straightforward being the [anaconda](https://docs.conda.io/projects/conda/en/stable/user-guide/install/index.html) suite). + + ### Quick start Without worrying about virtual environments (detailed further below), `stochtree` can be installed from the command line