Science Score: 44.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
○Committers with academic emails
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (15.4%) to scientific vocabulary
Repository
Sediment compaction
Basic Info
- Host: GitHub
- Owner: mcflugen
- License: mit
- Language: Python
- Default Branch: master
- Size: 119 KB
Statistics
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 1
- Releases: 0
Metadata Files
README.md
compaction: Compact layers of sediment
Compact a column of sediment following Bahr et al., 2001.
Cite as,
bibtex
@article{bahr2001exponential,
title={Exponential approximations to compacted sediment porosity profiles},
author={Bahr, David B and Hutton, Eric WH and Syvitski, James PM and Pratson, Lincoln F},
journal={Computers \& Geosciences},
volume={27},
number={6},
pages={691--700},
year={2001},
publisher={Pergamon}
}
Requirements
Compaction requires Python 3.
Apart from Python, Compaction has a number of other requirements, all of which can be obtained through either pip or conda, that will be automatically installed when you install Compaction.
To see a full listing of the requirements, have a look at the project's requirements.txt file.
If you are a developer of Compaction you will also want to install additional dependencies for running Compaction's tests to make sure that things are working as they should. These dependencies are listed in requirements-testing.txt.
Installation
To install Compaction, first create a new environment in which Compaction will be installed. This, although not necessary, will isolate the installation so that there won't be conflicts with your base Python installation. This can be done with conda as:
bash
conda create -n compaction python=3
conda activate compaction
Stable Release
Compaction, and its dependencies, can be installed either with pip or conda. Using pip:
bash
pip install compaction
Using conda:
bash
conda install compaction -c conda-forge
From Source
After downloading the Compaction source code, run the following from Compaction's top-level folder (the one that contains setup.py) to install Compaction into the current environment:
bash
pip install -e .
Input Files
Configuration File
The main Compaction input file is a yaml-formatted text file that lists constants used by Compaction. Running the following will print a sample Compaction configuration file:
compact show config
yaml
c: 5.0e-08
porosity_max: 0.5
porosity_min: 0.0
rho_grain: 2650.0
rho_void: 1000.0
Porosity File
The Compaction porosity file defines initial porosity of each of the sediment layers to be compacted as a two-column CSV file. The first column is layer thickness (in meters) and the second the porosity of the sediment in that layer. A sample porosity file can be obtained with:
bash
compact show porosity
```
Layer Thickness [m], Porosity [-]
100.0,0.5 100.0,0.5 100.0,0.5 ```
Output File
The output file of Compaction is a porosity file of the same form as the input porosity file - a CSV file of layer thickness and porosity.
Examples
To run a simulation using the sample input files described above, you first need to create a set of sample files:
sequence setup example
example/sequence.yaml
You can now run the simulation:
bash
sequence run example/sequence.yaml
```
Layer Thickness [m], Porosity [-]
100.0,0.5 96.18666488709239,0.4801774231522433 92.78860257194452,0.4611407154102571 ```
Owner
- Name: Eric Hutton
- Login: mcflugen
- Kind: user
- Location: Boulder, CO
- Company: University of Colorado
- Repositories: 135
- Profile: https://github.com/mcflugen
Citation (CITATION.cff)
# YAML 1.2
cff-version: 1.2.0
title: compaction
message: >-
If you use this software, please cite it using the
metadata from this file.
abstract: >-
Compact columns of layered sediment following the numerical
solution described in Bahr et al., 2001.
type: software
authors:
- given-names: Eric
family-names: Hutton
email: mcflugen@gmail.com
affiliation: University of Colorado
orcid: 'https://orcid.org/0000-0002-5864-6459'
repository-code: "https://github.com/mcflugen/compaction"
url: "https://github.com/mcflugen/compaction/blob/master/README.md"
date-released: "2022-06-26"
keywords:
- "bmi"
- "component modeling"
- "earth science"
- "landlab"
- "model coupling"
- "numerical modeling"
- "sediment compaction"
license: MIT
GitHub Events
Total
- Push event: 16
Last Year
- Push event: 16
Committers
Last synced: almost 2 years ago
Top Committers
| Name | Commits | |
|---|---|---|
| mcflugen | m****n@g****m | 121 |
Issues and Pull Requests
Last synced: 8 months ago
All Time
- Total issues: 0
- Total pull requests: 23
- Average time to close issues: N/A
- Average time to close pull requests: about 4 hours
- Total issue authors: 0
- Total pull request authors: 2
- Average comments per issue: 0
- Average comments per pull request: 0.96
- Merged pull requests: 22
- Bot issues: 0
- Bot pull requests: 1
Past Year
- Issues: 0
- Pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Issue authors: 0
- Pull request authors: 0
- Average comments per issue: 0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
Pull Request Authors
- mcflugen (23)
- pre-commit-ci[bot] (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 2
-
Total downloads:
- pypi 94 last-month
-
Total dependent packages: 2
(may contain duplicates) -
Total dependent repositories: 3
(may contain duplicates) - Total versions: 13
- Total maintainers: 1
pypi.org: compaction
Compact a column of sediment following Bahr et al., 2001.
- Documentation: https://compaction.readthedocs.io/
- License: MIT
-
Latest release: 0.2.3
published over 2 years ago
Rankings
Maintainers (1)
conda-forge.org: compaction
Sediment compaction and corresponding porosity variations are modeled by a simple exponential with depth. The porosity solution is derived analytically as a complicated function of pore water pressure, but the underlying form is shown to approximate an exponential except near the surface where the behavior is linear.
- Homepage: http://github.com/mcflugen/compaction
- License: MIT
-
Latest release: 0.2.2
published about 6 years ago
Rankings
Dependencies
- actions/checkout v3 composite
- actions/checkout v3 composite
- actions/setup-python v4 composite
- actions/checkout v3 composite
- actions/setup-python v4 composite
- actions/checkout v3 composite
- actions/setup-python v4 composite
- AndreMiras/coveralls-python-action develop composite
- actions/checkout v3 composite
- conda-incubator/setup-miniconda v2 composite
- click *
- landlab *
- numpy *
- pandas *
- pyyaml *
- scipy *
- tomlkit *
- pytest * test
- pytest-benchmark * test
- pytest-cov * test
- pytest-datadir * test
- pytest-mypy * test
- click *
- landlab *
- numpy *
- pandas *
- pyyaml *
- scipy *
- tomlkit *