Package: sed-plume
plume: A hypopycnal plume model built with landlabRequirementsplumerequires Python 3.Apart from Python,plumehas a number of other requirements, all of which
can be obtained through eitherpiporconda, that will be automatically
installed when you installplume.To see a full listing of the requirements, have a look at the project’srequirements.txtfile.If you are a developer ofplumeyou will also want to install
additional dependencies for runningplume’s tests to make sure
that things are working as they should. These dependencies are listed
inrequirements-testing.txt.InstallationTo installplume, first create a new environment in
whichplumewill be installed. This, although not necessary, will
isolate the installation so that there won’t be conflicts with your
basePythoninstallation. This can be done withcondaas:$condacreate-nplumepython=3$condaactivateplumeStable Releaseplume, and its dependencies, can be installed either withpiporconda. Usingpip:$pipinstallplumeUsingconda:$condainstallplume-cconda-forgeFrom SourceBefore buildingplumefrom source, you will need an installation of
the GNU Scientific Library (gsl). There are several ways to install
this but the easiest is throughconda,$mambainstallgslAfter downloading theplumesource code, run the following fromplume’s top-level folder (the one that containssetup.py) to
installplumeinto the current environment:$pipinstall-e.Input FilesConfiguration FileThe mainplumeinput file is a yaml-formatted text file that lists
constants used byplume. Running the following will print a sampleplumeconfiguration file:$plumegenerateplume.tomlThis will print something like the following,[plume]_version="0.2.0.dev0"[plume.grid]shape=[500,500]xy_spacing=[100.0,100.0]xy_of_lower_left=[0.0,0.0][plume.river]filepath="river.csv"width=50.0depth=5.0velocity=1.5location=[0.0,25000.0]angle=0.0[plume.sediment]removal_rate=60.0bulk_density=1600.0[plume.ocean]filepath="ocean.csv"along_shore_velocity=0.1sediment_concentration=0.0[plume.output]filepath="plume.nc"Ocean FileTheplumeocean file defines parameters of the ocean for each day of
the simulation. This is a csv-formatted text file today,along-shore velocity,
andsediment concentration.$plumegenerateocean.csv# version: 0.2.0.dev0
# Time [d], Along-shore velocity [m/s], Sediment Concentration [-]
0.0,0.1,0.0River FileTheplumeriver file is a csv-formatted text file that gives river parameters
for each day of the simulation. Columns aretime,river width,river depth,
andriver velocity.$plumegenerateriver.csv# version: 0.2.0.dev0
# Time [d], Width [m], Depth [m], Velocity [m/s]
0.0,50.0,5.0,1.5Theplumeriver file definesOutput FileThe only output file ofplumeis anetCDFfile that contains
sediment concentrations for each day of the simulation.ExamplesTo run a simulation using the sample input files described above, you first
need to create a set of sample files:$mkdirexample$plume--cd=examplesetupYou can now run the simulation:$plume--cd=examplerunCreditsDevelopment LeadsEric HuttonRelease Notes0.2.2 (2023-09-18)Other Changes and AdditionsUpdated thecythoncode used to calculate the centerline to fix a compile error
related to the update tocythonv3. (#10)Added support for Python 3.11, dropped Python 3.8. (#11)Added anoxfile for routine project maintenance and continuous
integration. (#12)0.2.1 (2022-06-29)Bug FixesFixed an error when trying to get the version from the command line withplume--version`. (#9)0.2.0 (2022-06-28)New FeaturesUpdated thePlumecomponent to be compatible withlandlabversion 2. This
will allowplumeto operate with the newest version oflandlaband be
incorporated into otherlandlabframeworks such as theSequencemodel. (#5)Change theplumecommand-line program to usetoml-formatted input files. (#5)Theplumemodel now builds and runs on Windows! (#5)Bug FixesFixed a bug where the existing deposit thickness was being zeroed-out before
the plume was run. The plume now adds sediment to an existing deposit and
leaves it up to the user to clear an existing deposit. (#7)Documentation EnhancementsUpdated the documentation to include installation instructions, usage and
examples. (#5)Other Changes and AdditionsSetup towncrier to manage the changelog. (#5)Switch fromversioneertozest.releaserto manage release versions. (#5)Set up continuous integration workflows using GitHub Actions. CI tests include
testing for code style usingblack, checking for lint withflake8,
testing notebooks and running the test suite. (#5)Updated the package metadata and moved static metaddata fromsetup.pytopyproject.toml. (#5)Setup up pre-commit hooks for ensuring style, lack of lint, python 3.8+
syntax, and clean notebooks. (#5)Added a citation file that users ofplumecan use to cite the software. (#6)Removed ocean and river time series from the plume command line interface.
The plume command now runs just a single plume. (#7)Added GitHub Actions workflows for pushing prereleases to TestPyPI and
releases to PyPI. (#8)0.1.0 (2018-06-13)FeaturesCreateplumepackage that simulates 1D (i.e. centerline), and 2D hypopycnal
plumes.Documentation EnhancementsAdded a newJupyternotebook that demonstrates how to use simulate 2D and 1D
plumes using theplumepackage. (#3)Other Changes and AdditionsSet up continuous integration testing with Travis-CI. CI builds are run
for Linux and Mac. Windows support is not yet available. (#1)Added a suite of tests, which usepytest, for testing theplumepackage. (#2)Addedversioneerto manage package release versions. (#4)