Skip to content

Commit 77dee9a

Browse files
committed
Add all downstream OpenBioSim dependencies.
1 parent a84d50c commit 77dee9a

8 files changed

Lines changed: 28 additions & 23 deletions

File tree

.github/workflows/choose_branch.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ jobs:
6161
build-args: --help
6262
#
6363
- name: Generate recipe
64-
run: python ${{ github.workspace }}/actions/generate_recipe.py --features bss emle
64+
run: python ${{ github.workspace }}/actions/generate_recipe.py --features obs emle
6565
#
6666
- name: Write Python variant config
6767
shell: bash

.github/workflows/devel.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ jobs:
5454
build-args: --help
5555
#
5656
- name: Generate recipe
57-
run: python ${{ github.workspace }}/actions/generate_recipe.py --features bss emle
57+
run: python ${{ github.workspace }}/actions/generate_recipe.py --features obs emle
5858
#
5959
- name: Write Python variant config
6060
shell: bash

.github/workflows/main.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ jobs:
5656
build-args: --help
5757
#
5858
- name: Generate recipe
59-
run: python ${{ github.workspace }}/actions/generate_recipe.py --features bss emle
59+
run: python ${{ github.workspace }}/actions/generate_recipe.py --features obs emle
6060
#
6161
- name: Write Python variant config
6262
shell: bash

.github/workflows/pr.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ jobs:
5656
build-args: --help
5757
#
5858
- name: Generate recipe
59-
run: python ${{ github.workspace }}/actions/generate_recipe.py --features bss emle
59+
run: python ${{ github.workspace }}/actions/generate_recipe.py --features obs emle
6060
#
6161
- name: Write Python variant config
6262
shell: bash

README.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ A small word of warning, the compilation can easily take over an hour!
133133
Other pixi environments are available depending on your needs:
134134

135135
* ``pixi install -e default`` - core sire dependencies only
136-
* ``pixi install -e bss`` - include BioSimSpace compatibility dependencies
136+
* ``pixi install -e obs`` - include downstream OpenBioSim package dependencies
137137
* ``pixi install -e emle`` - include EMLE engine dependencies
138138
* ``pixi install -e dev`` - all of the above plus test dependencies
139139

actions/generate_recipe.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
appropriate if/then conditional blocks for platform-specific dependencies.
66
77
Usage:
8-
python actions/generate_recipe.py [--features bss emle]
8+
python actions/generate_recipe.py [--features obs emle]
99
1010
The --features flag controls which optional dependency groups are
1111
included in the host section of the recipe.
@@ -66,7 +66,7 @@ def parse_args():
6666
"--features",
6767
nargs="*",
6868
default=[],
69-
help="Optional feature groups to include (e.g. bss emle)",
69+
help="Optional feature groups to include (e.g. obs emle)",
7070
)
7171
parser.add_argument(
7272
"--pixi-toml",

doc/source/install.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -317,13 +317,13 @@ install all required dependencies, including compilers:
317317
Several environments are available depending on your needs:
318318

319319
* ``default`` - core sire dependencies only
320-
* ``bss`` - include `BioSimSpace <https://biosimspace.org>`__ compatibility dependencies
320+
* ``obs`` - include downstream OpenBioSim package dependencies (e.g. BioSimSpace)
321321
* ``emle`` - include EMLE engine dependencies
322-
* ``full`` - include both BSS and EMLE dependencies
322+
* ``full`` - include both OBS and EMLE dependencies
323323
* ``dev`` - all of the above plus test dependencies
324324

325325
If you plan to install `BioSimSpace <https://biosimspace.org>`__ on
326-
top of :mod:`sire`, use at least the ``bss`` or ``dev`` environment.
326+
top of :mod:`sire`, use at least the ``obs`` or ``dev`` environment.
327327
This ensures that incompatible versions of shared dependencies are not
328328
accidentally installed.
329329

@@ -404,7 +404,7 @@ definitions:
404404

405405
.. code-block:: bash
406406
407-
$ python actions/generate_recipe.py --features bss emle
407+
$ python actions/generate_recipe.py --features obs emle
408408
409409
This creates ``recipes/sire/recipe.yaml``. The ``--features`` flag controls
410410
which optional dependency groups are included. Omit features to build a
@@ -413,7 +413,7 @@ lighter package:
413413
.. code-block:: bash
414414
415415
$ python actions/generate_recipe.py # core only
416-
$ python actions/generate_recipe.py --features bss # core + BioSimSpace
416+
$ python actions/generate_recipe.py --features obs # core + BioSimSpace
417417
418418
You can edit the generated ``recipe.yaml`` to further customise the
419419
dependency pins if needed.

pixi.toml

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -52,17 +52,18 @@ kartograf = ">=1.0.0"
5252
pybind11 = "==2.11.1"
5353

5454
# =============================================================================
55-
# BSS (BioSimSpace) feature
56-
# These aren't needed by Sire, but allow it to be built in a self-consistent
57-
# way so that BioSimSpace can be installed on top of it.
55+
# OBS (OpenBioSim) feature
56+
# Dependencies for downstream OpenBioSim packages (biosimspace, ghostly, loch, somd2).
5857
# =============================================================================
59-
[feature.bss.dependencies]
58+
[feature.obs.dependencies]
6059
openmmtools = ">=0.21.5"
6160
configargparse = "*"
6261
ipywidgets = "*"
6362
kcombu_bss = "*"
63+
loguru = "*"
6464
lomap2 = "*"
6565
nglview = "*"
66+
numba = "*"
6667
openff-interchange-base = "*"
6768
openff-toolkit-base = "*"
6869
parmed = "*"
@@ -71,26 +72,30 @@ pydot = "*"
7172
pygtail = "*"
7273
pyyaml = "*"
7374

74-
[feature.bss.target.linux-64.dependencies]
75+
[feature.obs.target.linux-64.dependencies]
7576
ambertools = ">=22"
7677
gromacs = "*"
7778
alchemlyb = "*"
7879
mdtraj = "*"
7980
mdanalysis = "*"
81+
# loch/somd2 deps (pycuda/pyopencl only available on linux-64)
82+
pyopencl = "*"
83+
pycuda = "*"
84+
nvidia-ml-py = "*"
8085

81-
[feature.bss.target.linux-aarch64.dependencies]
86+
[feature.obs.target.linux-aarch64.dependencies]
8287
ambertools = ">=22"
8388
gromacs = "*"
8489
# alchemlyb, mdtraj, mdanalysis not available on linux-aarch64
8590

86-
[feature.bss.target.osx-arm64.dependencies]
91+
[feature.obs.target.osx-arm64.dependencies]
8792
ambertools = ">=22"
8893
# gromacs not available on osx-arm64
8994
alchemlyb = "*"
9095
mdtraj = "*"
9196
mdanalysis = "*"
9297

93-
[feature.bss.target.win-64.dependencies]
98+
[feature.obs.target.win-64.dependencies]
9499
# ambertools and gromacs not available on Windows
95100
alchemlyb = "*"
96101
mdtraj = "*"
@@ -150,8 +155,8 @@ kartograf = ">=1.0.0"
150155
# =============================================================================
151156
[environments]
152157
default = []
153-
bss = ["bss"]
158+
obs = ["obs"]
154159
emle = ["emle"]
155-
full = ["bss", "emle"]
160+
full = ["obs", "emle"]
156161
test = ["test"]
157-
dev = ["bss", "emle", "test"]
162+
dev = ["obs", "emle", "test"]

0 commit comments

Comments
 (0)