Blobmodel
Blobmodel: A Python package for generating superpositions of pulses in one and two dimensions - Published in JOSS (2025)
Science Score: 93.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 1 DOI reference(s) in JOSS metadata -
○Academic publication links
-
○Academic email domains
-
○Institutional organization owner
-
✓JOSS paper metadata
Published in Journal of Open Source Software
Keywords
Scientific Fields
Repository
Model of propagating blobs in 1D and 2D
Basic Info
- Host: GitHub
- Owner: uit-cosmo
- License: mit
- Language: Python
- Default Branch: main
- Homepage: https://blobmodel.readthedocs.io
- Size: 55.6 MB
Statistics
- Stars: 6
- Watchers: 0
- Forks: 2
- Open Issues: 3
- Releases: 4
Topics
Metadata Files
README.md
blobmodel 
This package provides realizations of advecting and dissipating blobs in up to two dimensions.
All blob parameters can be choosen freely, and multiple blob shapes are implemented. Originally, the model is developed for studying the scrape-off layer of fusion experiments, but it can be applicable to many 1d or 2d systems. See the blobmodel documentation for further details.
Examples for one and two dimensions are shown below:
| 1D | 2D |
|---|---|
|
|
Installation
The package is published to PyPI and can be installed with
sh
pip install blobmodel
If you want the development version you must first clone the repo to your local machine, then install the project in development mode:
sh
git clone https://github.com/uit-cosmo/blobmodel.git
cd blobmodel
python -m pip install -e .
Usage
Create a grid on which the blobs are discretized using the Model class. The make_realization() method computes the output as an xarray dataset which can also be written out as a netcdf file if the argument file_name is specified. A simple example is shown below:
```Python from blobmodel import Model, show_model
bm = Model(Nx=200, Ny=100, Lx=10, Ly=10, dt=0.1, T=20, num_blobs=100)
ds = bm.makerealization(filename="example.nc")
The data can be shown as an animation using the `show_model` function:
Python
show_model(ds)
```
You can specify the blob parameters with a BlobFactory class. The DefaultBlobFactory class has some of the most common distribution functions implemented. An example would look like this:
```Python from blobmodel import DefaultBlobFactory, DistributionEnum, Model
use DefaultBlobFactory to define distribution functions of random variables
myblobfactory = DefaultBlobFactory(Adist=DistributionEnum.normal, Aparameter=5)
pass on myblobfactory when creating the Model
bm = Model(
Nx=100,
Ny=100,
Lx=10,
Ly=10,
dt=0.1,
T=20,
blobfactory=myblobfactory,
tdrain=100,
numblobs=100,
)
``
Alternatively, you can specify all blob parameters exactly as you want by writing your own class which inherits from BlobFactory. Seeexamples/customblobfactory.py` as an example or take a look at the blobmodel documentation.
Contributing
Feel free to raise issues about anything. Contributions through pull requests are also very welcome. Please take a look at our Contributor guide for further details.
Owner
- Name: Complex Systems Modelling - UiT
- Login: uit-cosmo
- Kind: organization
- Website: https://uit.no/research/dynamo
- Repositories: 12
- Profile: https://github.com/uit-cosmo
Research group at UiT devoted to modelling of complex physical, biological, ecological and socio-economic systems.
JOSS Publication
Blobmodel: A Python package for generating superpositions of pulses in one and two dimensions
Authors
Tags
pulses imaging data tokamaks turbulenceGitHub Events
Total
- Create event: 16
- Commit comment event: 2
- Release event: 2
- Issues event: 22
- Delete event: 4
- Member event: 1
- Issue comment event: 22
- Push event: 67
- Pull request review comment event: 13
- Pull request event: 31
- Pull request review event: 16
Last Year
- Create event: 16
- Commit comment event: 2
- Release event: 2
- Issues event: 22
- Delete event: 4
- Member event: 1
- Issue comment event: 22
- Push event: 67
- Pull request review comment event: 13
- Pull request event: 31
- Pull request review event: 16
Issues and Pull Requests
Last synced: 4 months ago
All Time
- Total issues: 23
- Total pull requests: 53
- Average time to close issues: about 1 month
- Average time to close pull requests: 21 days
- Total issue authors: 4
- Total pull request authors: 4
- Average comments per issue: 1.26
- Average comments per pull request: 0.57
- Merged pull requests: 45
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 15
- Pull requests: 29
- Average time to close issues: 9 days
- Average time to close pull requests: about 22 hours
- Issue authors: 4
- Pull request authors: 2
- Average comments per issue: 1.2
- Average comments per pull request: 0.38
- Merged pull requests: 24
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- gregordecristoforo (9)
- andrewgiuliani (5)
- EmilyBourne (5)
- Sosnowsky (4)
Pull Request Authors
- Sosnowsky (33)
- gregordecristoforo (17)
- audunth (2)
- ema109 (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 617 last-month
- Total dependent packages: 1
- Total dependent repositories: 0
- Total versions: 6
- Total maintainers: 2
pypi.org: blobmodel
Two dimensional model of propagating blobs
- Documentation: https://blobmodel.readthedocs.io/
- License: MIT License Copyright (c) 2021 Gregor Decristoforo Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
Latest release: 1.1.1
published 6 months ago
Rankings
Maintainers (2)
Dependencies
- black ^22.1.0
- docformatter ^1.4
- matplotlib ^3.5.1
- mypy ^0.931
- nptyping ^1.4.4
- numpy ^1.22.2
- pytest ^7.0.1
- python >=3.10,<3.11
- scipy ^1.8.0
- tqdm ^4.62.3
- xarray ^0.21.1
- actions/checkout v3 composite
- actions/checkout v2 composite
- actions/setup-python v4 composite
- codecov/codecov-action v3 composite
- alabaster ==0.7.13
- babel ==2.12.1
- black ==23.7.0
- certifi ==2023.5.7
- cftime ==1.6.2
- charset-normalizer ==3.2.0
- click ==8.1.6
- contourpy ==1.1.0
- coverage ==7.2.7
- cycler ==0.11.0
- docutils ==0.18.1
- fonttools ==4.41.0
- idna ==3.4
- imagesize ==1.4.1
- iniconfig ==2.0.0
- jinja2 ==3.1.2
- kiwisolver ==1.4.4
- markupsafe ==2.1.3
- matplotlib ==3.7.2
- mypy ==1.4.1
- mypy-extensions ==1.0.0
- netcdf4 ==1.6.4
- nptyping ==2.5.0
- numpy ==1.25.1
- packaging ==23.1
- pandas ==2.0.3
- pathspec ==0.11.1
- pillow ==10.0.0
- platformdirs ==3.9.1
- pluggy ==1.2.0
- pygments ==2.15.1
- pyparsing ==3.0.9
- pytest ==7.4.0
- pytest-cov ==4.1.0
- python-dateutil ==2.8.2
- pytz ==2023.3
- requests ==2.31.0
- six ==1.16.0
- snowballstemmer ==2.2.0
- sphinx ==6.2.1
- sphinx-rtd-theme ==1.2.2
- sphinxcontrib-applehelp ==1.0.4
- sphinxcontrib-devhelp ==1.0.2
- sphinxcontrib-htmlhelp ==2.0.1
- sphinxcontrib-jquery ==4.1
- sphinxcontrib-jsmath ==1.0.1
- sphinxcontrib-qthelp ==1.0.3
- sphinxcontrib-serializinghtml ==1.1.5
- tqdm ==4.65.0
- typing-extensions ==4.7.1
- tzdata ==2023.3
- urllib3 ==2.0.4
- xarray ==2023.7.0
- alabaster ==0.7.13
- babel ==2.12.1
- black ==23.7.0
- certifi ==2023.5.7
- cftime ==1.6.2
- charset-normalizer ==3.2.0
- click ==8.1.6
- contourpy ==1.1.0
- coverage ==7.2.7
- cycler ==0.11.0
- docutils ==0.18.1
- fonttools ==4.41.0
- idna ==3.4
- imagesize ==1.4.1
- iniconfig ==2.0.0
- jinja2 ==3.1.2
- kiwisolver ==1.4.4
- markupsafe ==2.1.3
- matplotlib ==3.7.2
- mypy ==1.4.1
- mypy-extensions ==1.0.0
- netcdf4 ==1.6.4
- nptyping ==2.5.0
- numpy ==1.25.1
- packaging ==23.1
- pandas ==2.0.3
- pathspec ==0.11.1
- pillow ==10.0.0
- platformdirs ==3.9.1
- pluggy ==1.2.0
- pygments ==2.15.1
- pyparsing ==3.0.9
- pytest ==7.4.0
- pytest-cov ==4.1.0
- python-dateutil ==2.8.2
- pytz ==2023.3
- requests ==2.31.0
- six ==1.16.0
- snowballstemmer ==2.2.0
- sphinx ==6.2.1
- sphinx-rtd-theme ==1.2.2
- sphinxcontrib-applehelp ==1.0.4
- sphinxcontrib-devhelp ==1.0.2
- sphinxcontrib-htmlhelp ==2.0.1
- sphinxcontrib-jquery ==4.1
- sphinxcontrib-jsmath ==1.0.1
- sphinxcontrib-qthelp ==1.0.3
- sphinxcontrib-serializinghtml ==1.1.5
- tqdm ==4.65.0
- typing-extensions ==4.7.1
- tzdata ==2023.3
- urllib3 ==2.0.4
- xarray ==2023.7.0
