Skip to content

Commit e55c86b

Browse files
author
SimonBoothroyd
authored
Migrate all reference from omnia to C-F. (#345)
1 parent f4e793c commit e55c86b

File tree

4 files changed

+21
-28
lines changed

4 files changed

+21
-28
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ The best place to get acquainted with the framework is through the mini-tutorial
3232
To install the OpenFF Evaluator from conda, simply run
3333

3434
```
35-
conda install -c conda-forge -c omnia openff-evaluator
35+
conda install -c conda-forge openff-evaluator
3636
```
3737

3838
#### License

docs/developer/releaseprocess.rst

+17-24
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Release Process
22
===============
33

4-
This document aims to outline the steps needed to release the ``openff-evaluator`` on ``omnia``. This
4+
This document aims to outline the steps needed to release the ``openff-evaluator`` on ``conda-forge``. This
55
should only be done with the approval of the core maintainers.
66

77
1. Update the Release History
@@ -70,37 +70,30 @@ To cut a new release on GitHub:
7070

7171
*Note - You do not need to upload any files. The source code will automatically be added as a `.tar.gz` file.*
7272

73-
3: Trigger a New Build on Omnia
74-
-------------------------------
73+
3: Trigger a New Build on Conda Forge
74+
-------------------------------------
7575

76-
To trigger the build in ``omnia``:
76+
To trigger the build on ``conda-forge``:
7777

78-
1) Create branch or fork of omnia-md/conda-recipes with the following changes to openff-evaluator in
79-
`meta.yaml <https://github.com/omnia-md/conda-recipes/blob/master/openff-evaluator/meta.yaml>`_:
78+
1) Create a fork of the `openff-evaluator-feedstock <https://github.com/conda-forge/openff-evaluator-feedstock>`_ and
79+
make the following changes to the ``recipe/meta.yaml`` file:
8080

81-
a) Set ``git_tag`` to match the git release tag
82-
b) Update the ``version`` to match the release (this will go into the conda package name)
83-
c) Set ``build`` to 0
84-
d) Update any dependencies in the ``requirements`` section
85-
e) If we want to push to special ``rc`` label use ``extra.upload``
81+
a) Update the ``version`` to match the release.
82+
b) Set ``build`` to 0
83+
c) Update any dependencies in the ``requirements`` section
84+
d) Update the sha256 hash to the output of ``curl -sL https://github.com/openforcefield/openff-evaluator/archive/{{ version }}.tar.gz | openssl sha256``
8685

87-
2) Open PR to merge branch or fork into omnia-md master:
86+
2) Open PR to merge the fork into the main feedstock:
8887

89-
a) The PR title should have the format ``[openff-evaluator] X.Y.Z (label: rc)``
88+
a) The PR title should have the format ``Release X.Y.Z``
9089
b) No PR body text is needed
91-
c) Travis will run on this PR (~30 minutes) and attempt to build the package. Under no conditions will the package
92-
be uploaded before the PR is merged. This step is just to ensure that building doesn't crash.
93-
d) If the build is successful the PR should be reviewed and merged by the ``omnia`` maintainers
94-
e) **Once merged into master** the package is built again on travis, and pushed to the channel set in
95-
meta.yaml (``main``, ``beta``, or ``rc``)
90+
c) The CI will run on this PR (~30 minutes) and attempt to build the package.
91+
d) If the build is successful the PR should be reviewed and merged by the feedstock maintainers.
92+
e) **Once merged** the package is built again on and uploaded to anaconda.
9693

97-
3) Test the ``omnia`` package:
94+
3) Test the ``conda-forge`` package:
9895

99-
a) ``conda install -c omnia openff-evaluator``
100-
101-
*Note: Omnia builds take about 30 minutes to run. When you open a PR the build will run, and you can check the bottom
102-
of the travis logs for "package failed to build" listings. Some packages always fail (protons, assaytools), but
103-
``openff-evaluator`` shouldn't be there. Ctrl-F for ``openff-evaluator`` to ensure that it did build at all though.*
96+
a) ``conda install -c conda-forge openff-evaluator``
10497

10598
4: Update the ReadTheDocs Build Versions
10699
--------------------------------------------

docs/install.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ followed and conda is available on your machine.
1212
Installation from Conda
1313
-----------------------
1414

15-
To install the ``openff-evaluator`` from the ``omnia`` channel, simply run::
15+
To install the ``openff-evaluator`` from the ``conda-forge`` channel simply run::
1616

17-
conda install -c conda-forge -c omnia openff-evaluator
17+
conda install -c conda-forge openff-evaluator
1818

1919
Recommended Dependencies
2020
------------------------

docs/tutorials/colab_setup.ipynb

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
"\n",
1515
"!wget https://raw.githubusercontent.com/openforcefield/openff-evaluator/master/devtools/conda-envs/test_env.yaml\n",
1616
"!sed -i -z 's/python\\n/python ==3.6.9\\n/g' test_env.yaml\n",
17-
"!. /usr/local/etc/profile.d/conda.sh && conda env update --name base --file test_env.yaml && conda install --yes -c conda-forge -c omnia forcebalance && conda list\n",
17+
"!. /usr/local/etc/profile.d/conda.sh && conda env update --name base --file test_env.yaml && conda install --yes -c conda-forge forcebalance && conda list\n",
1818
"\n",
1919
"!pip install git+https://github.com/openforcefield/openff-evaluator.git@master\n",
2020
"!wget https://raw.githubusercontent.com/openforcefield/openff-forcefields/7300a486581feff508b9401241443f941924783f/openforcefields/offxml/openff-1.0.0.offxml\n",

0 commit comments

Comments
 (0)