Skip to content

Commit

Permalink
Merge branch 'develop' of github.com:QMCSoftware/QMCSoftware into dev…
Browse files Browse the repository at this point in the history
…elop
  • Loading branch information
alegresor committed May 23, 2022
2 parents b35e38d + 46d99e3 commit c216988
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 13 deletions.
24 changes: 12 additions & 12 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@ Thank you for you interest in contributing to the QMCPy package. The following s

## Installation for Developers

To enable `conda` environments, [install miniconda](https://docs.conda.io/en/latest/miniconda.html).
To enable `conda` environments, [install miniconda](https://docs.conda.io/en/latest/miniconda.html).

Then, setup the `qmcpy` virtual environment

~~~
git clone https://github.com/QMCSoftware/QMCSoftware.git
cd QMCSoftware
git checkout develop
conda env create --file requirements/environment.yml
conda env create --name qmcpy python=3.7.12 --file requirements/environment.ymlv
conda activate qmcpy
pip install -e .
~~~
Expand Down Expand Up @@ -47,7 +47,7 @@ pip install -e .

----

## Documentation
## Documentation

Automated project documentation is compiled with [Sphinx](http://www.sphinx-doc.org/). To compile HTML, PDF, or EPUB docs locally into `sphinx/_build/` you must install [pandoc](https://pandoc.org/installing.html), a [latex distribution](https://www.latex-project.org/get/), and add additional python requirements with the command

Expand All @@ -67,7 +67,7 @@ make doc_epub

## Workouts and Demos

Workouts extensively test and compare the components of the QMCPy package. Demos, implemented as Jupyter notebooks, demonstrate functionality and uses cases for QMCPy. They often draw on results from corresponding workouts.
Workouts extensively test and compare the components of the QMCPy package. Demos, implemented as Jupyter notebooks, demonstrate functionality and uses cases for QMCPy. They often draw on results from corresponding workouts.

To run all workouts (~10 min) use the command

Expand All @@ -91,23 +91,23 @@ See the `makefile` for individual testing commands.

## Pull Requests

Pull requests should be made into the `develop` branch, as we try and keep the `master` branch consistent with the current release.
Pull requests should be made into the `develop` branch, as we try and keep the `master` branch consistent with the current release.

**For a QMCPy component (generator, algorithm, use case) try to ...**

- incorporate and be consistent with other QMCPy components as much as possible.
- keep naming conventions the same across similar components.
- keep naming conventions the same across similar components.
- develop thorough documentation, including doctests. See `qmcpy/stopping_criterion/cub_qmc_sobol_g.py` as an example.
- create fast and/or long unittests in the `test/` directory.
- create fast and/or long unittests in the `test/` directory.
- create a workout or demo showcasing your new component, preferably including
- a connection/comparison to available components.
- how the expected cost is realized.
- an overview of the relevant mathematics.
- a connection/comparison to available components.
- how the expected cost is realized.
- an overview of the relevant mathematics.
- figures to illustrate important features.
- references.
- references.
- consider submitting a blog to put on the [QMCPy blogs site](http://qmcpy.wordpress.com/).

**For a bug fix, try to**

- fix/add doctests and unittests.
- update documentation/references.
- update documentation/references.
10 changes: 9 additions & 1 deletion makefile
Original file line number Diff line number Diff line change
Expand Up @@ -95,4 +95,12 @@ workout:

exportcondaenv:
@-rm -f requirements/environment.yml 2>/dev/null &
@conda env export --no-builds | grep -v "^prefix: " > requirements/environment.yml
@conda env export --no-builds | grep -v "^prefix: " > requirements/environment.yml

conda_dev:
@conda create -n qmcpy python=3.7.0
@conda activate qmcpy
@conda install conda-build
@conda develop .
@pip install -r requirements/dev.txt
@pip install -e .

0 comments on commit c216988

Please sign in to comment.