search

conda-forge / plasticparcels-feedstock

A conda-smithy repository for plasticparcels.
BSD 3-Clause "New" or "Revised" License
0 stars 2 forks source link

readme

About plasticparcels-feedstock

Feedstock license: BSD-3-Clause

Home: https://github.com/OceanParcels/plasticparcels

Package license: MIT

Summary: Ready-to-use tool for plastic dispersion simulations and parameterisation development

Development: https://github.com/OceanParcels/plasticparcels

Documentation: https://plastic.oceanparcels.org

plasticparcels is a python package for simulating the transport and dispersion of plastics in the ocean. The tool is based on the parcels computational Lagrangian ocean analysis framework, providing a modular and customisable collection of methods, notebooks, and tutorials for advecting virtual plastic particles with a wide range of physical properties.

Current build status

All platforms:

Current release info

Name Downloads Version Platforms
Conda Recipe Conda Downloads Conda Version Conda Platforms

Installing plasticparcels

Installing plasticparcels 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, plasticparcels can be installed with conda:

conda install plasticparcels

or with mamba:

mamba install plasticparcels

It is possible to list all of the versions of plasticparcels available on your platform with conda:

conda search plasticparcels --channel conda-forge

or with mamba:

mamba search plasticparcels --channel conda-forge

Alternatively, mamba repoquery may provide more information:

# Search all versions available on your platform:
mamba repoquery search plasticparcels --channel conda-forge

# List packages depending on `plasticparcels`:
mamba repoquery whoneeds plasticparcels --channel conda-forge

# List dependencies of `plasticparcels`:
mamba repoquery depends plasticparcels --channel conda-forge

About conda-forge

Powered by NumFOCUS

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.

Terminology

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)

Updating plasticparcels-feedstock

If you would like to improve the plasticparcels 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/plasticparcels-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:

Feedstock Maintainers