Skip to content

Commit

Permalink
doc: Update installation.rst (RST!)
Browse files Browse the repository at this point in the history
  • Loading branch information
lavakyan committed Mar 5, 2021
1 parent 2639d44 commit 561364c
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 6 deletions.
3 changes: 1 addition & 2 deletions doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,6 @@
'sphinx.ext.mathjax',
'sphinx.ext.viewcode',
'sphinx.ext.githubpages',
'sphinx.ext.autosectionlabel' # for in-text links to captions
]

# Add any paths that contain templates here, relative to this directory.
Expand Down Expand Up @@ -71,7 +70,7 @@
exclude_patterns = []

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = None
pygments_style = 'sphinx'

autoclass_content = 'both'

Expand Down
11 changes: 7 additions & 4 deletions doc/source/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Stable version published on PyPi <https://pypi.org/project/mstm-studio/>.
The source code of MSTM is not included and should be obtained from <https://scattport.org/index.php/light-scattering-software/multiple-particle-scattering/468-mstm>.
MSTM studio can be run without MSTM binary, but with restricted functionality.

For non-spherical particles (currently available only spheroids) the ScatterPy library is used (See :ref:`Binding with ScatterPy`).
For non-spherical particles (currently available only spheroids) the ScatterPy library is used (See :ref:`binding-scatterpy`).


Linux installation
Expand Down Expand Up @@ -91,6 +91,8 @@ Binding with MSTM
The last command (``PAUSE``) is put to prevent console windows from closing after program is ended.


.. _binding-scatterpy:

Binding with ScatterPy
----------------------

Expand All @@ -107,15 +109,16 @@ ScatterPy requires Numba library for speeding up the calculation. However, it is
2. Edit file ``scatterpy/special.py``:
Remove line

``import numba as nb``
``import numba as nb``

and add lines:

``` try:
.. code-block:: python
try:
import numba as nb
except ImportError:
print('WARNING: Numba support is disabled in ScatterPy')
```


3. Build and install: ``python setup.py install`` (Needed setuptools and may be other dev packages)
Expand Down

0 comments on commit 561364c

Please sign in to comment.