The nircam_jdox repository is meant to act as a simple collection of code and ancillary data files that have been used to create tables and figures on the NIRCam JDox webpages.
Getting nircam_jdox up and running on your own computer requires four steps, detailed below:
- Cloning the GitHub repository
- Installing the
condaenvironment - Installing the python package
It is highly suggested that contributors have a working installation of anaconda or miniconda for Python 3.6. Downloads and installation instructions are available here:
Requirements for contributing to the nircam_jdox package will be included in the nircam_jdox conda environment, which is included in our installation instructions below.
You first need to clone the current version of nircam_jdox. The simplest way to do this is to go to the directory you want your copy of the repository to be in and clone the repository there. Once you are in the directory you can do the following:
git clone https://github.com/spacetelescope/nircam_jdox.git
cd nircam_jdox
or, if you would rather use SSH instead of https, type
git clone git@github.com:spacetelescope/nircam_jdox.git
cd nircam_jdox
instead, and then proceed as stated.
Following the download of the nircam_jdox repository, contributors can then install the nircam_jdox conda environment via the environment.yml file, which contains all of the dependencies for the project. First, one should ensure that their version of conda is up to date:
conda update conda
Next, one should activate the base environment:
source activate base
Lastly, one can create the nircam_jdox environment via the environment.yml file:
conda env create -f environment.yml
Next, you need to install the nircam_jdox package. While still in the nircam_jdox/ directory, run the following command to set up the package:
python setup.py develop
The package should now appear if you run conda list nircam_jdox.
Before you begin contributing to the nircam_jdox development please review our suggested git workflow page, which contains an in-depth explanation of the workflow.
The following is a bare-bones example of a best work flow for contributing to the project:
- Create a fork off of the
spacetelescopenircam_jdoxrepository. - Make a local clone of your fork.
- Ensure your personal fork is pointing
upstreamproperly. - Create a branch on that personal fork.
- Make your software changes.
- Push that branch to your personal GitHub repository (i.e.
origin). - On the
spacetelescopenircam_jdoxrepository, create a pull request that merges the branch intospacetelescope:master. - Assign a reviewer from the team for the pull request.
- Iterate with the reviewer over any needed changes until the reviewer accepts and merges your branch.
- Delete your local copy of your branch.
Users who wish to report an issue or request a new feature may do so by submitting a new issue on GitHub: https://github.com/spacetelescope/nircam_jdox/issues
Users and contributors to the nircam_jdox repository should adhere to the Code of Conduct. Any issues or violations pertaining to the Code of Conduct should be brought to the attention of a nircam_jdox team member.