bluemira

Bluemira is an integrated inter-disciplinary design tool for future fusion reactors. It incorporates several modules, some of which rely on other codes, to carry out a range of typical conceptual fusion reactor design activities.

https://github.com/fusion-power-plant-framework/bluemira

Science Score: 67.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
Found 3 DOI reference(s) in README
✓
Academic publication links
Links to: sciencedirect.com, iop.org, zenodo.org
○
Academic email domains
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (13.9%) to scientific vocabulary

Keywords

design-optimisation nuclear-fusion tokamaks

Last synced: 6 months ago · JSON representation ·

Repository

Basic Info

Host: GitHub
Owner: Fusion-Power-Plant-Framework
License: lgpl-2.1
Language: Python
Default Branch: develop
Homepage: https://bluemira.readthedocs.io/
Size: 74 MB

Statistics

Stars: 85
Watchers: 9
Forks: 22
Open Issues: 170
Releases: 29

Topics

design-optimisation nuclear-fusion tokamaks

Created almost 5 years ago · Last pushed 6 months ago

Metadata Files

Readme Contributing License Code of conduct Citation Codeowners

README.md

Bluemira

Bluemira is an integrated inter-disciplinary design tool for future fusion reactors. It incorporates several modules, some of which rely on other codes, to carry out a range of typical conceptual fusion reactor design activities.

Bluemira was created from two similar codes: BLUEPRINT and MIRA (see publications).

Work in Progress!

The bluemira team has been working hard since mid-2021 to combine BLUEPRINT and MIRA into a single reactor design framework. We took the opportunity to embark upon a significant refactor of both code bases, delivering improved functionality, code quality, and hopefully maintainability. This, along with some resourcing issues has caused our feature roadmap to slip. A lot of functionality that was present in BLUEPRINT and MIRA is not yet available in bluemira.

Bluemira is very much under active development, and will likely be subject to API changes in the near future. We apologise in advance for these. Please do get in touch before starting to use any modules, so we can warn you of changes to come.

Below is an overview of our development roadmap for 2024/25:

Modules

Bluemira is composed of various modules:

balance_of_plant: power balance solver and tools
base: the software backbone of the bluemira framework
codes: interfaces to external codes (both API and file PI)
display: plotting and display module
equilibria: equilibrium solvers and objects
fuel_cycle: fuel cycle model
geometry: the geometry "engine" of the bluemira framework
magnetostatics: magnetostatics solvers
materials: materials module
optimisation: interface to optimisers and associated tools
plasma_physics: 0-D plasma physics tools
radiation_transport [WIP]: radiation and advection transport solvers
structural: beam finite element structural solver
utilities: collection of utility toolboxes for file IO, databases, machine learning, and misc.

Publications

The bluemira code and its modules are described in the following publications:

As bluemira is the result of an integration between two historical codes, some previous publications may also be of interest.

The BLUEPRINT code and its modules are described in the following publications:

The MIRA code and its modules are described in the following publications:

Terms of use

Bluemira is released under the LGPLv2.1 license, but we also ask that you show professional courtesy when using this code:

Since you are benefiting from work on bluemira, we ask that you submit any improvements you make to the code to us by submitting a pull request to this repository. If you are looking to develop aspects of this code or add parts to it, please contact us beforehand so that we can help/advise if necessary.
If you use bluemira results in a paper or professional publication, we ask that you discuss your work and results with one of the bluemira authors first so that we can check them. It is not necessary to list bluemira developers as co-authors. If one or more of the bluemira team are involved in preparing results or new functionality used in your work, then those members should be offered a co-authorship.
If you use bluemira or any of its modules in your work, please help ensure that all the authors get the credit they deserve by citing the relevant bluemira, BLUEPRINT, and MIRA papers.

For a full list of existing publications, see here.

Code of conduct

See code of conduct.

Installation

See our installation guide.

Developing

For working on bluemira you will also need to install the development dependencies and the git pre-commit hook:

shell python -m pip install --no-cache-dir -e .'[dev]' pre-commit install -f

Please see the guidelines for contributing to bluemira.

Tests are run with pytest. To run the main tests:

shell pytest

To run all the tests:

shell pytest --reactor --longrun --plotting-on

pytest also supports running individual test files and selecting tests by name or using a regular expression. See the pytest documentation.

After a test run an html report of the results can be found in report.html. A test coverage report can be found in the htmlcov directory.

Further information about our testing can be found here.

Building Documentation

The documentation is built with Sphinx. In addition the API documentation is created by sphinx-apidoc.

To build the html documentation execute this command: shell sphinx-build documentation/source documentation/build

New pages can be added by adding them to the documentation/source directory and adding a link in the toctree section of index.rst. The index page lives at documentation/build/index.html. API documentation will be automatically generated from the bluemira source code.

Owner

Name: Fusion-Power-Plant-Framework
Login: Fusion-Power-Plant-Framework
Kind: organization

Repositories: 1
Profile: https://github.com/Fusion-Power-Plant-Framework

Citation (CITATION.cff)

cff-version: 1.2.0
authors:
  - family-names: Coleman
    given-names: M.
    affiliation: United Kingdom Atomic Energy Authority, Culham Science Centre, Abingdon, Oxfordshire OX14 3DB, United Kingdom; EUROfusion Consortium, Boltzmannstr.2, Garching, 85748, Germany

  - family-names: Cook
    given-names: J. E.
    affiliation: United Kingdom Atomic Energy Authority, Culham Science Centre, Abingdon, Oxfordshire OX14 3DB, United Kingdom

  - family-names: Franza
    given-names: F.
    affiliation: Karlsruher Institut f&uuml;r Technologie, Hermann-von-Helmholtz-Platz 1, 76344 Eggenstein-Leopoldshafen, Germany

  - family-names: Maione
    given-names: I. A.
    affiliation: Karlsruher Institut f&uuml;r Technologie, Hermann-von-Helmholtz-Platz 1, 76344 Eggenstein-Leopoldshafen, Germany

  - family-names: McIntosh
    given-names: S.
    affiliation: United Kingdom Atomic Energy Authority, Culham Science Centre, Abingdon, Oxfordshire OX14 3DB, United Kingdom; ITER Organization, Route de Vinon-sur-Verdon, CS 90 046, 13067 St Paul Lez Durance Cedex, France

  - family-names: Morris
    given-names: J.
    affiliation: United Kingdom Atomic Energy Authority, Culham Science Centre, Abingdon, Oxfordshire OX14 3DB, United Kingdom

  - family-names: Short
    given-names: D.
    affiliation: United Kingdom Atomic Energy Authority, Culham Science Centre, Abingdon, Oxfordshire OX14 3DB, United Kingdom

  - family-names: Blair
    given-names: A. I.
    affiliation: United Kingdom Atomic Energy Authority, Culham Science Centre, Abingdon, Oxfordshire OX14 3DB, United Kingdom

  - family-names: Bluteau
    given-names: M.
    affiliation: United Kingdom Atomic Energy Authority, Culham Science Centre, Abingdon, Oxfordshire OX14 3DB, United Kingdom

  - family-names: Brooks
    given-names: H.
    affiliation: United Kingdom Atomic Energy Authority, Culham Science Centre, Abingdon, Oxfordshire OX14 3DB, United Kingdom

  - family-names: Chiang
    given-names: I.
    affiliation: United Kingdom Atomic Energy Authority, Culham Science Centre, Abingdon, Oxfordshire OX14 3DB, United Kingdom

  - family-names: Desai
    given-names: S.
    affiliation: United Kingdom Atomic Energy Authority, Culham Science Centre, Abingdon, Oxfordshire OX14 3DB, United Kingdom

  - family-names: Foord
    given-names: M.
    affiliation: Agile Abstractions, Northampton, United Kingdom

  - family-names: Funk
    given-names: O.
    affiliation: United Kingdom Atomic Energy Authority, Culham Science Centre, Abingdon, Oxfordshire OX14 3DB, United Kingdom

  - family-names: Graham
    given-names: G. A.
    affiliation: United Kingdom Atomic Energy Authority, Culham Science Centre, Abingdon, Oxfordshire OX14 3DB, United Kingdom

  - family-names: Hagues
    given-names: J.
    affiliation: United Kingdom Atomic Energy Authority, Culham Science Centre, Abingdon, Oxfordshire OX14 3DB, United Kingdom

  - family-names: Humphrey
    given-names: L.
    affiliation: United Kingdom Atomic Energy Authority, Culham Science Centre, Abingdon, Oxfordshire OX14 3DB, United Kingdom

  - family-names: Johnson
    given-names: M.
    affiliation: United Kingdom Atomic Energy Authority, Culham Science Centre, Abingdon, Oxfordshire OX14 3DB, United Kingdom

  - family-names: Kahn
    given-names: S.
    affiliation: United Kingdom Atomic Energy Authority, Culham Science Centre, Abingdon, Oxfordshire OX14 3DB, United Kingdom

  - family-names: MacMackin
    given-names: C.
    affiliation: United Kingdom Atomic Energy Authority, Culham Science Centre, Abingdon, Oxfordshire OX14 3DB, United Kingdom

  - family-names: Mason
    given-names: S.
    affiliation: United Kingdom Atomic Energy Authority, Culham Science Centre, Abingdon, Oxfordshire OX14 3DB, United Kingdom

  - family-names: Mould
    given-names: C. L.
    affiliation: United Kingdom Atomic Energy Authority, Culham Science Centre, Abingdon, Oxfordshire OX14 3DB, United Kingdom

  - family-names: Saunders
    given-names: H.
    affiliation: United Kingdom Atomic Energy Authority, Culham Science Centre, Abingdon, Oxfordshire OX14 3DB, United Kingdom

  - family-names: Vaccaro
    given-names: D.
    affiliation: United Kingdom Atomic Energy Authority, Culham Science Centre, Abingdon, Oxfordshire OX14 3DB, United Kingdom

  - family-names: Wong
    given-names: O.
    affiliation: United Kingdom Atomic Energy Authority, Culham Science Centre, Abingdon, Oxfordshire OX14 3DB, United Kingdom

message: "If you use this software, please cite it using these references."
references:
  - type: article
    title: "BLUEPRINT: A novel approach to fusion reactor design"
    authors:
      - family-names: Coleman
        given-names: M
      - family-names: McIntosh
        given-names: S
    doi: 10.1016/j.fusengdes.2018.12.036
    year: 2019
    volume: 139
    journal: Fusion Engineering and Design
  - type: article
    title: "Development and Validation of a Computational Tool for Fusion Reactors' System Analysis"
    authors:
      - family-names: Franza
        given-names: F
    doi: 10.5445/IR/1000095873
    year: 2019
title: "bluemira"
license: LGPL-2.1-or-later
repository-code: "https://github.com/Fusion-Power-Plant-Framework/bluemira"
url: "https://bluemira.readthedocs.io/en/develop"

Issues and Pull Requests

Last synced: 6 months ago

All Time

Total issues: 157
Total pull requests: 533
Average time to close issues: 11 months
Average time to close pull requests: about 1 month
Total issue authors: 18
Total pull request authors: 19
Average comments per issue: 0.86
Average comments per pull request: 2.2
Merged pull requests: 331
Bot issues: 11
Bot pull requests: 269

Past Year

Issues: 62
Pull requests: 218
Average time to close issues: 3 months
Average time to close pull requests: 6 days
Issue authors: 8
Pull request authors: 14
Average comments per issue: 0.48
Average comments per pull request: 1.75
Merged pull requests: 120
Bot issues: 6
Bot pull requests: 68

View more stats

Top Authors

Issue Authors

oliverfunk (60)
je-cook (49)
OceanNuclear (18)
geograham (18)
DanShort12 (16)
github-actions[bot] (13)
tplobo (12)
kj5248 (10)
CoronelBuendia (10)
sebkahn (8)
clmould (7)
dependabot[bot] (4)
athoynilimanew (4)
hsaunders1904 (3)
DarioV86 (2)

Pull Request Authors

dependabot[bot] (476)
je-cook (168)
fppf-bot (47)
oliverfunk (46)
geograham (43)
OceanNuclear (36)
athoynilimanew (30)
kj5248 (14)
CoronelBuendia (12)
clmould (11)
DarioV86 (6)
github-actions[bot] (4)
ivanmaione (3)
tplobo (3)
bielsnohr (2)

Top Labels

Issue Labels

bug (33) geometry (24) quality (21) enhancement (20) STEP (19) to_do (17) release (14) equilibria (13) tests (12) cad (12) radiation_transport (11) documentation (10) should (9) 📜 Papercut (9) codes (8) powercycle (7) dependencies (7) display (5) tf_coil (5) must (5) magnetostatics (5) python (5) EU-DEMO (5) installation (4) plasma (4) optimisation (4) base (4) easy (4) continuous_integration (4) could (4)

Pull Request Labels

dependencies (528) python (513) blocked (52) quality (47) bug (43) equilibria (38) continuous_integration (35) enhancement (24) geometry (24) documentation (22) tests (15) radiation_transport (15) base (13) codes (12) neutronics (11) optimisation (10) upstream (9) cad (9) magnetostatics (9) installation (8) examples (7) utilities (6) github_actions (6) EU-DEMO (6) release (5) 📜 Papercut (4) powercycle (4) fuelcycle (3) materials (3) bluemira_strategy (3)

Dependencies

requirements-develop.txt pypi

bandit ==1.7.4 development
black ==22.3.0 development
coverage ==6.3.3 development
flake8 ==4.0.1 development
flake8-absolute-import ==1.0.0.1 development
flake8-bandit ==3.0.0 development
flake8-docstrings ==1.6.0 development
pep8-naming ==0.12.1 development
pre-commit ==2.19.0 development
pytest ==7.1.2 development
pytest-cov ==3.0.0 development
pytest-html ==3.1.1 development
pytest-json-report ==1.5.0 development
pytest-metadata ==2.0.1 development
sphinx ==4.5.0 development
sphinx-autoapi ==1.8.4 development
sphinx-rtd-theme ==1.0.0 development
versioneer ==0.22 development

requirements.txt pypi

Babel ==2.10.1
CoolProp ==6.4.1
Jinja2 ==3.1.2
MarkupSafe ==2.1.1
MeshPy ==2020.1
Pillow ==9.1.1
Pint ==0.19.2
Pygments ==2.12.0
Send2Trash ==1.8.0
Shapely ==1.8.2
anytree ==2.8.0
appdirs ==1.4.4
appnope ==0.1.3
argon2-cffi ==21.3.0
argon2-cffi-bindings ==21.2.0
asteval ==0.9.26
attrs ==21.4.0
backcall ==0.2.0
bleach ==5.0.0
cffi ==1.15.0
click ==8.1.3
cycler ==0.11.0
decorator ==5.1.1
defusedxml ==0.7.1
entrypoints ==0.4
fluids ==1.0.21
fortranformat ==1.2.0
gmsh ==4.9.3
gmsh-interop ==2021.1.1
imageio ==2.19.2
importlib-metadata ==4.11.3
importlib-resources ==5.7.1
iniconfig ==1.1.1
ipykernel ==6.13.0
ipython ==8.3.0
ipython-genutils ==0.2.0
jedi ==0.18.1
joblib ==1.1.0
jsonschema ==4.5.1
jupyter-client ==7.3.1
jupyter-core ==4.10.0
jupyterlab-pygments ==0.2.2
kiwisolver ==1.4.2
llvmlite ==0.38.0
matplotlib ==3.5.2
mistune ==0.8.4
natsort ==8.1.0
nbclient ==0.6.3
nbconvert ==6.5.0
nbformat ==5.4.0
nest-asyncio ==1.5.5
neutronics-material-maker ==0.1.11
nlopt ==2.7.0
notebook ==6.4.12
numba ==0.55.1
numba-scipy ==0.3.0
numexpr ==2.8.1
numpy ==1.21.5
packaging ==21.3
pandas ==1.4.2
pandocfilters ==1.5.0
parso ==0.8.3
periodictable ==1.6.0
pexpect ==4.8.0
pickleshare ==0.7.5
pluggy ==1.0.0
prometheus-client ==0.14.1
prompt-toolkit ==3.0.29
ptyprocess ==0.7.0
py ==1.11.0
pybind11 ==2.9.2
pyclipper ==1.3.0.post2
pycparser ==2.21
pyparsing ==3.0.9
pypet ==0.6.0
pyquaternion ==0.9.9
pyrsistent ==0.18.1
pytest ==7.1.2
python-dateutil ==2.8.2
pytools ==2022.1.7
pytz ==2022.1
pyzmq ==22.3.0
scikit-learn ==1.1.0
scipy ==1.5.3
seaborn ==0.11.2
six ==1.16.0
tables ==3.7.0
tabulate ==0.8.9
terminado ==0.13.3
testpath ==0.6.0
threadpoolctl ==3.1.0
toml ==0.10.2
tornado ==6.1
traitlets ==5.2.0
typing-extensions ==4.2.0
wcwidth ==0.2.5
webencodings ==0.5.1
wrapt ==1.14.1
zipp ==3.8.0

.github/workflows/check_release_due.yml actions

actions/checkout v3 composite

.github/workflows/ci.yml actions

actions/cache v3 composite
actions/checkout v3 composite
actions/upload-artifact v3 composite
codecov/codecov-action v3 composite
conda-incubator/setup-miniconda v2 composite

.github/workflows/comments.yml actions

actions/checkout v3 composite
peter-evans/create-or-update-comment v2 composite
peter-evans/find-comment v2 composite
potiuk/get-workflow-origin v1_4 composite

.github/workflows/examples.yml actions

actions/checkout v3 composite
conda-incubator/setup-miniconda v2 composite

.github/workflows/ff.yml actions

actions/checkout v3 composite
endre-spotlab/fast-forward-js-action master composite
xt0rted/pull-request-comment-branch v1 composite

.github/workflows/release.yml actions

actions/checkout v3 composite

docker/docker-compose.yml docker

bluemira latest
bluemira develop

requirements-conda.txt pypi

PySide2 ==5.15.5
PyYAML ==6.0
Shapely ==2.0.0
appdirs ==1.4.4
cached-property ==1.5.2
cftime ==1.6.2
gmsh-interop ==2021.1.1
h5py ==3.7.0
importlib-metadata ==5.2.0
pybind11 ==2.10.1
pybind11-global ==2.10.1
pytools ==2022.1.13
shiboken2 ==5.15.5
sympy ==1.11.1
typing_extensions ==4.4.0
vtk ==9.1.0
zipp ==3.11.0

requirements-examples.txt pypi

Jinja2 ==3.1.2
MarkupSafe ==2.1.1
Pygments ==2.13.0
Send2Trash ==1.8.0
argon2-cffi ==21.3.0
argon2-cffi-bindings ==21.2.0
asttokens ==2.2.1
attrs ==22.1.0
backcall ==0.2.0
beautifulsoup4 ==4.11.1
bleach ==5.0.1
cffi ==1.15.1
debugpy ==1.6.4
decorator ==5.1.1
defusedxml ==0.7.1
entrypoints ==0.4
executing ==1.2.0
fastjsonschema ==2.16.2
importlib-resources ==5.10.1
ipykernel ==6.19.2
ipython ==8.7.0
ipython-genutils ==0.2.0
jedi ==0.18.2
jsonschema ==4.17.3
jupyter-client ==7.4.8
jupyter-core ==5.1.0
jupyterlab-pygments ==0.2.2
jupytext ==1.14.4
matplotlib-inline ==0.1.6
mistune ==2.0.4
nbclient ==0.7.2
nbconvert ==7.2.6
nbformat ==5.7.0
nest-asyncio ==1.5.6
notebook ==6.5.2
pandocfilters ==1.5.0
parso ==0.8.3
pexpect ==4.8.0
pickleshare ==0.7.5
prometheus-client ==0.15.0
prompt-toolkit ==3.0.36
psutil ==5.9.4
ptyprocess ==0.7.0
pure-eval ==0.2.2
pycparser ==2.21
pyrsistent ==0.19.2
pyzmq ==24.0.1
soupsieve ==2.3.2.post1
stack-data ==0.6.2
terminado ==0.17.1
tinycss2 ==1.2.1
tornado ==6.2
traitlets ==5.7.1
wcwidth ==0.2.5
webencodings ==0.5.1
zipp ==3.11.0

conda/environment.yml pypi

pyproject.toml pypi

Babel *
CoolProp *
anytree *
asteval *
click *
contourpy *
fortranformat *
gmsh *
imageio *
matplotlib >=3.5
meshio *
neutronics-material-maker ==0.1.11
nlopt *
numba *
numba-scipy *
numpy *
periodictable *
pint *
pyclipper *
pypet *
pyquaternion *
rich *
scikit-learn *
scipy *
seaborn *
tables *
tabulate *
typeguard >3.0.0

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Open Source Science