Package: roman-datamodels
Roman Datamodels SupportInstallationThe easiest way to install the latestroman-datamodelsrelease into a fresh virtualenv or conda environment ispip install roman-datamodelsDetailed InstallationTheroman-datamodelspackage can be installed into a virtualenv or conda environment viapip. We recommend that for each
installation you start by creating a fresh environment that only has Python installed and then install theroman_datamodelspackage and its dependencies into that bare environment. If using conda environments, first make sure you have a recent
version of Anaconda or Miniconda installed. If desired, you can create multiple environments to allow for switching
between different versions of theroman-datamodelspackage (e.g. a released version versus the current development version).In all cases, the installation is generally a 3-step process:Create a conda environmentActivate that environmentInstall the desired version of theroman-datamodelspackage into that environmentDetails are given below on how to do this for different types of installations, including tagged releases, DMS builds
used in operations, and development versions. Remember that all conda operations must be done from within a bash shell.Installing latest releasesYou can install the latest released version viapip. From a bash shell:conda create -n <env_name> python
conda activate <env_name>
pip install roman-datamodelsNoteAlternatively, you can also usevirtualenvto create an environment;
however, this installation method is not supported by STScI if you encounter issues.You can also install a specific version (fromroman-datamodels 0.1.0onward):conda create -n <env_name> python
conda activate <env_name>
pip install roman-datamodels==0.5.0Installing the development version from GithubYou can install the latest development version (not as well tested) from the Github main branch:conda create -n <env_name> python
conda activate <env_name>
pip install git+https://github.com/spacetelescope/roman_datamodelsInstalling for DevelopersIf you want to be able to work on and test the source code with theroman-datamodelspackage, the high-level procedure to do
this is to first create a conda environment using the same procedures outlined above, but then install your personal
copy of the code overtop of the original code in that environment. Again, this should be done in a separate conda
environment from any existing environments that you may have already installed with released versions of theroman-datamodelspackage.As usual, the first two steps are to create and activate an environment:conda create -n <env_name> python
conda activate <env_name>To install your own copy of the code into that environment, you first need to fork and clone theroman_datamodelsrepo:cd <where you want to put the repo>
git clone https://github.com/spacetelescope/roman_datamodels
cd roman_datamodelsNoteInstalling viasetup.py(python setup.py install,python setup.py develop, etc.) is deprecated and does not work.Install from your local checked-out copy as an "editable" install:pip install -e .If you want to run the unit or regression tests and/or build the docs, you can make sure those dependencies are
installed too:pip install -e ".[test]"
pip install -e ".[docs]"
pip install -e ".[test,docs]"Need other useful packages in your development environment?pip install ipython pytest-xdist