https://github.com/britishgeologicalsurvey/disolv
Science Score: 23.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
○codemeta.json file
-
○.zenodo.json file
-
✓DOI references
Found 1 DOI reference(s) in README -
✓Academic publication links
Links to: wiley.com -
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (11.4%) to scientific vocabulary
Last synced: 11 months ago
·
JSON representation
Repository
Basic Info
- Host: GitHub
- Owner: BritishGeologicalSurvey
- License: lgpl-3.0
- Language: Python
- Default Branch: master
- Size: 1.01 MB
Statistics
- Stars: 2
- Watchers: 6
- Forks: 1
- Open Issues: 0
- Releases: 0
Created over 6 years ago
· Last pushed over 6 years ago
https://github.com/BritishGeologicalSurvey/disolv/blob/master/
# DISOLV
The following is a brief description of the input/output structure. For a full description of the code see our paper: Collins S, Bianchi M (2020) DISOLV: A Python package for the interpretation of borehole dilution tests. *Groundwater*. [Available here](https://ngwa.onlinelibrary.wiley.com/doi/abs/10.1111/gwat.12992)
## Installation
DISOLV can be installed for Python 2.7 or Python 3 using pip:
```
pip install disolv
```
It can be used within other Python code with:
```python
import disolv
disolv.run('input_dir', 'output_dir', calibrate=True, convertFEC=True,
method='SLSQP')
```
## Structure of input files
### in.csv
This file contains the main input parameters. Do not delete any lines from the file.

### flows.csv
This file contains the depths and flow rates of the fractures. If used in forward mode, the two columns *Upper depth limit* and *Lower depth limit* are not required. Positive flows are inflows and negative flows are outflows. If using the code for FFEC logging (i.e. a pumped borehole), add the depth and flow rate of the pump to this file, as you would a fracture.

### initialcondition.csv
This file contains the depth vs. concentration data for the initial state. DISOLV will interpolate the data onto a 1D grid with the spatial discretization given in *in.csv*. If these data are FEC data rather than concentration data (e.g. in kg/m3), DISOLV can convert them to concentration data by setting the argument *convertFEC* to 'True'.

### measuredprofiles.csv
This file contains the measured profiles at the output times defined in *in.csv*. This is a required input for inversion modelling but optional for forward modelling.

## Running the model
DISOLV can be imported and run as follows:
```python
import disolv
disolv.run('input_dir', 'output_dir', calibrate=False, convertFEC=False)
```
The first and second arguments are the file paths to the input and output directories. *Calibrate* refers to whether the model is being run in forward ('False') or inverse ('True') mode, and *convertFEC* indicates whether the initial condition has been given in fluid electrical conductivity (S cm1) and must be converted to concentration (in kg m3) (True) or whether it has been given as a concentration (False).
If DISOLV is run in inverse mode, the optimization method can be chosen in the final argument:
```python
disolv.run('input_dir', 'output_dir', calibrate=True, convertFEC=False, method='SLSQP')
```
## Output
The modelled depth vs. concentration data can be found in *Output\profiles.csv*. If used in inversion mode, *Output.csv* will contain the optimized output parameters.
The modelled data and measured data (if given) are plotted in *profiles.csv*.

Owner
- Name: British Geological Survey
- Login: BritishGeologicalSurvey
- Kind: organization
- Email: enquiries@bgs.ac.uk
- Location: Keyworth, Nottinghamshire
- Website: https://www.bgs.ac.uk
- Twitter: BritGeoSurvey
- Repositories: 71
- Profile: https://github.com/BritishGeologicalSurvey
The British Geological Survey is responsible for advising the UK government on geoscience and providing impartial advice to industry, academia and the public.
GitHub Events
Total
Last Year
Dependencies
requirements.txt
pypi
- matplotlib *
- numpy *
- pandas *
- scipy *
setup.py
pypi
- matplotlib *
- numpy *
- pandas *
- scipy *