Setup#

User setup#

Obtaining multistar#

To install on Unix-like systems (Linux, MacOS)

ssh-keygen -a 256 -t ed25519

send ~/.ssh/id_ed25519.pub to get git repository access.

ssh-agent $SHELL
ssh-add
[type passphrase]
cd
mkdir python
cd python
git clone git@star.sci.monash.edu:python/source

In .bashrc or .zshrc., add ${HOME}/python/source and ${HOME}/python/source/projects to PYTHONPATH and ${HOME}/python/source/bin to PATH environment variables.

export PYTHONPATH=${HOME}/python/source:${HOME}/python/source/projects:${PYTHONPATH}
export PATH=${HOME}/python/source/bin:${PATH}

Required Python modules#

apng

numpy

numpy-quaternion

scipy

Cython

meson

ninja

libconf

matplotlib

psutil

pillow

tqdm

py-cpuinfo

PyYAML

tqdm

pip install -U ipython apng numpy numpy-quaternion scipy Cython meson ninja libconf matplotlib psutil pillow py-cpuinfo PyYAML tqdm

Recommended Python modules#

ipython

vtk

plotly

kepler (not public)

pip install -U ipython vtk plotly

Note

vtk tends to be a bit behind, wheels for pip are only made when a new version is released after a well-established Python release. Very annoying.

System packages#

LaTeX

ffmpeg

Documentation#

Required Python packages#

sphinx

sphinx_rtd_theme

pydata_sphinx_theme

sphinx-design

pip install -U sphinx sphinx_rtd_theme pydata_sphinx_theme sphinx-design

Building documentation#

To compile the documentation, go to subdirectory multistar/doc and set up meson:

meson setup _build
cd _build
meson compile html

You can point your web browser to the local folder under multistar/doc/_build/html/index.html

Installing documentation#

To put files on the server (c), I use

meson compile web