Skip to content

Commit 658c8e8

Browse files
committed
Refer users to cmdstanpy installation guide for help to install cmdstanpy and CmdStan
1 parent b9639d8 commit 658c8e8

File tree

1 file changed

+4
-28
lines changed

1 file changed

+4
-28
lines changed

README.md

Lines changed: 4 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -25,32 +25,19 @@ Download the excel template from the [excel-pseudobatch folder](./excel-pseudoba
2525
The Python package holds functions which apply the pseudobatch transformation to data either in the form of `Numpy` Arrays or `Pandas` dataframe. Please visit [our documentation]() to how to use the Python package.
2626

2727
## How to install?
28-
The Pseudobatch Python package can be install through PYPI using pip. Most of the functionality can be installed simply be calling
28+
The Pseudobatch Python package can be install through PYPI using pip. Most of the functionality can be installed simply by calling
2929

3030
```shell
3131
pip install pseudobatch
3232
```
3333

34-
The error propagation functionality requires installation of cmdstanpy and CmdStan. Thus, installing the error propagation functionality takes a few steps. First install cmdstanpy in the prefered virtual environment.
35-
36-
```shell
37-
pip install cmdstanpy
38-
```
39-
40-
Second, use cmdstanpy to install CmdStan. To due this you need to call use the function `cmdstanpy.install_cmdstan()`. This can for example be done by opening a python session in the terminal and run the following two Python commands
41-
42-
```python
43-
import cmdstanpy
44-
cmdstanpy.install_cmdstan()
45-
```
46-
47-
Now exit the Python session and install the remaining dependencies of the error propagation module through pip.
34+
The error propagation functionality requires installation of cmdstanpy and CmdStan. Please see the cmdstanpy documentation for how to install both cmdstanpy and CmdStan in your specific setup (https://mc-stan.org/cmdstanpy/installation.html). After successfully installing both proceed to install the remaining dependencies of the error propagation module through pip.
4835

4936
```shell
5037
pip install pseudobatch[error_propagation]
5138
```
5239

53-
Now the error propagation module is installed and ready to use.
40+
Now the error propagation module is installed and ready to use. Note that the first time you import the error propagation module CmdStan will compile the Stan model this will take several minutes.
5441

5542
## How to cite
5643
If you use the pseudobatch transformation please cite the original article XXX.
@@ -74,15 +61,4 @@ have installed all the dependencies by running `pip install -e
7461
.'[development]'` from the project root. Next, change directory to `docs` and
7562
run the command `make html`. To view your changes run `open
7663
build/html/index.html` or just click through to this file using your file
77-
explorer.
78-
79-
## Building docker image
80-
This is a note to developers who wants to rebuild/update the docker image. If you simply want to use the docker image see the description in the [article folder](./article/README.md).
81-
82-
The Docker container relies on the [jupyter/datascience-notebook](https://hub.docker.com/r/jupyter/datascience-notebook/tags/), see also [here](https://jupyter-docker-stacks.readthedocs.io/en/latest/using/selecting.html#jupyter-datascience-notebook). We used this image because it includes both Python and Julia out of the box, the down side is that it is quite large. To create the image you need a local copy of this repository and inside that folder run the following command:
83-
84-
```
85-
docker build . -t pseudobatch:{version}
86-
```
87-
88-
This recreates the docker image. Be aware that installing the Julia packages and cmdstan are both take quite some time, thus expect that it take ~ 15 - 30 min to build.
64+
explorer.

0 commit comments

Comments
 (0)