Skip to content

Commit e1b5745

Browse files
authored
Merge pull request #95 from ucl-cssb/isntallation_update
Fixed installation issue in documentation
2 parents 0d8f1cd + 1122eb1 commit e1b5745

3 files changed

Lines changed: 9 additions & 47 deletions

File tree

README.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,8 @@ The repository is organized into the following main directories:
6262
Installation
6363
------------
6464

65+
.. install-begin
66+
6567
Prerequisites
6668
^^^^^^^^^^^^^
6769

@@ -157,6 +159,7 @@ Compilers
157159
"""""""""
158160
A g++ compiler is required for the PyMC3 package.
159161

162+
.. install-end
160163
161164
Usage
162165
-----

docs/source/installation.rst

Lines changed: 3 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -5,47 +5,6 @@ Installation
55
============
66

77

8-
Stable release
9-
--------------
10-
11-
To install MIMIC, run this command in your terminal:
12-
13-
.. code-block:: console
14-
15-
$ pip install mimic
16-
17-
This is the preferred method to install MIMIC, as it will always install the most recent stable release.
18-
19-
If you don't have `pip`_ installed, this `Python installation guide`_ can guide
20-
you through the process.
21-
22-
.. _pip: https://pip.pypa.io
23-
.. _Python installation guide: http://docs.python-guide.org/en/latest/starting/installation/
24-
25-
26-
From sources
27-
------------
28-
29-
The sources for MIMIC can be downloaded from the `Github repo`_.
30-
31-
You can either clone the public repository:
32-
33-
.. code-block:: console
34-
35-
$ git clone git://github.com/Fontanapink/mimic
36-
37-
Or download the `tarball`_:
38-
39-
.. code-block:: console
40-
41-
$ curl -OJL https://github.com/Fontanapink/mimic/tarball/master
42-
43-
Once you have a copy of the source, you can install it with:
44-
45-
.. code-block:: console
46-
47-
$ python setup.py install
48-
49-
50-
.. _Github repo: https://github.com/Fontanapink/mimic
51-
.. _tarball: https://github.com/Fontanapink/mimic/tarball/master
8+
.. include:: ../../README.rst
9+
:start-after: install-begin
10+
:end-before: install-end

mimic/model_infer/infer_VAR_bayes.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -279,7 +279,7 @@ def _run_inference_large(self, **kwargs) -> None:
279279
c2 = pm.InverseGamma("c2", 2, 8)
280280
tau = pm.HalfCauchy("tau", beta=tau0)
281281
lam = pm.HalfCauchy("lam", beta=1, shape=(ndim, ndim))
282-
A = pm.Normal('A', mu=A_prior_mu, sigma=tau * lam * \
282+
A = pm.Normal('A', mu=A_prior_mu, sigma=tau * lam *
283283
at.sqrt(c2 / (c2 + tau**2 * lam**2)), shape=(ndim, ndim))
284284

285285
# If noise covariance is provided, use it as a prior
@@ -438,14 +438,14 @@ def _run_inference_large_xs(self, **kwargs) -> None:
438438
c2_A = pm.InverseGamma("c2_A", 2, 1)
439439
tau_A = pm.HalfCauchy("tau_A", beta=tau0_A)
440440
lam_A = pm.HalfCauchy("lam_A", beta=1, shape=(nX, nX))
441-
Ah = pm.Normal('Ah', mu=A_prior_mu, sigma=tau_A * lam_A * \
441+
Ah = pm.Normal('Ah', mu=A_prior_mu, sigma=tau_A * lam_A *
442442
at.sqrt(c2_A / (c2_A + tau_A**2 * lam_A**2)), shape=(nX, nX))
443443

444444
tau0_B = (DB0 / (DB - DB0)) * 0.1 / np.sqrt(N)
445445
c2_B = pm.InverseGamma("c2_B", 2, 1)
446446
tau_B = pm.HalfCauchy("tau_B", beta=tau0_B)
447447
lam_B = pm.HalfCauchy("lam_B", beta=1, shape=(nS, nX))
448-
Bh = pm.Normal('Bh', mu=0, sigma=tau_B * lam_B * \
448+
Bh = pm.Normal('Bh', mu=0, sigma=tau_B * lam_B *
449449
at.sqrt(c2_B / (c2_B + tau_B**2 * lam_B**2)), shape=(nS, nX))
450450

451451
if noise_cov_prior is not None:

0 commit comments

Comments
 (0)