beast
beast copied to clipboard
Packages to install during set-up
In the installation instructions, in the requirements section, we say to do
$ conda install -n astroconda pytables
$ conda install -n astroconda hdf5
and in the installation for production runs, we have
$ conda install astropy scipy h5py matplotlib cython
(which, based on my experience in #548, should maybe be changed to conda install -c anaconda [list of packages]
).
In setup.cfg
, these are the required packages:
install_requires = Cython; astropy; scipy; matplotlib; h5py; tables; dust_extinction; tqdm; photutils; shapely
We should probably consolidate the package installation instructions, and also make it consistent with what's in setup.cfg
.
Here's what ended up working for me:
conda install -c anaconda astropy cython hdf5 h5py matplotlib pytables scipy
conda install -c conda-forge shapely tqdm
conda install -c astropy photutils
And depending on when dust_extinction has its next release (https://github.com/karllark/dust_extinction/issues/142), one of these:
pip install git+https://github.com/karllark/dust_extinction.git
conda install -c conda-forge dust_extinction
Also just noticed that there are some packages needed for building docs, and those aren't listed anywhere.
See docs/requirements.txt. :-)
Thanks! I somehow hadn't found those before. Should we add them to the developer documentation? (Maybe here??) The error message when I ran python setup.py build_docs
was less helpful than it could have been.
Actually, this will be handled better once I update the package files to the new APE17 method. See #541. I've already done this for the megabeast and it has a nice section in the config.cfg file that captures this info [options.extras_require]
. That should solve the problem as the building of the docs is done better.
Updating to APE17 will require an update to the developer docs as the commands for testing, building docs, etc. change.