Feedstock license: BSD-3-Clause
Home: https://github.com/sxs-collaboration/sxs
Package license: MIT
Summary: A collection of python code used by the SXS collaboration
Development: https://github.com/sxs-collaboration/sxs
This package provides a number of utilities for use by the SXS collaboration, and others who use our data.
For example, the metadata
subpackage provides functions for reading and analyzing the metadata files
provided with SXS simulations for describing the physics they represent. Another important subpackage is
zenodo
, which provides handy functions for interacting with zenodo.org in general, and in particular our
collection of simulation data on that site.
All platforms: |
Name | Downloads | Version | Platforms |
---|---|---|---|
Installing sxs
from the conda-forge
channel can be achieved by adding conda-forge
to your channels with:
conda config --add channels conda-forge
conda config --set channel_priority strict
Once the conda-forge
channel has been enabled, sxs
can be installed with conda
:
conda install sxs
or with mamba
:
mamba install sxs
It is possible to list all of the versions of sxs
available on your platform with conda
:
conda search sxs --channel conda-forge
or with mamba
:
mamba search sxs --channel conda-forge
Alternatively, mamba repoquery
may provide more information:
# Search all versions available on your platform:
mamba repoquery search sxs --channel conda-forge
# List packages depending on `sxs`:
mamba repoquery whoneeds sxs --channel conda-forge
# List dependencies of `sxs`:
mamba repoquery depends sxs --channel conda-forge
conda-forge is a community-led conda channel of installable packages. In order to provide high-quality builds, the process has been automated into the conda-forge GitHub organization. The conda-forge organization contains one repository for each of the installable packages. Such a repository is known as a feedstock.
A feedstock is made up of a conda recipe (the instructions on what and how to build the package) and the necessary configurations for automatic building using freely available continuous integration services. Thanks to the awesome service provided by Azure, GitHub, CircleCI, AppVeyor, Drone, and TravisCI it is possible to build and upload installable packages to the conda-forge anaconda.org channel for Linux, Windows and OSX respectively.
To manage the continuous integration and simplify feedstock maintenance
conda-smithy has been developed.
Using the conda-forge.yml
within this repository, it is possible to re-render all of
this feedstock's supporting files (e.g. the CI configuration files) with conda smithy rerender
.
For more information please check the conda-forge documentation.
feedstock - the conda recipe (raw material), supporting scripts and CI configuration.
conda-smithy - the tool which helps orchestrate the feedstock.
Its primary use is in the construction of the CI .yml
files
and simplify the management of many feedstocks.
conda-forge - the place where the feedstock and smithy live and work to produce the finished article (built conda distributions)
If you would like to improve the sxs recipe or build a new
package version, please fork this repository and submit a PR. Upon submission,
your changes will be run on the appropriate platforms to give the reviewer an
opportunity to confirm that the changes result in a successful build. Once
merged, the recipe will be re-built and uploaded automatically to the
conda-forge
channel, whereupon the built conda packages will be available for
everybody to install and use from the conda-forge
channel.
Note that all branches in the conda-forge/sxs-feedstock are
immediately built and any created packages are uploaded, so PRs should be based
on branches in forks and branches in the main repository should only be used to
build distinct package versions.
In order to produce a uniquely identifiable distribution:
- If the version of a package is not being increased, please add or increase
the
build/number
. - If the version of a package is being increased, please remember to return
the
build/number
back to 0.