https://github.com/bamresearch/bam-masterdata
Repository containing the masterdata definitions of the BAM Data Store project
Science Score: 26.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
-
○Academic publication links
-
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (19.6%) to scientific vocabulary
Keywords
Repository
Repository containing the masterdata definitions of the BAM Data Store project
Basic Info
- Host: GitHub
- Owner: BAMresearch
- License: mit
- Language: Python
- Default Branch: main
- Homepage: https://bamresearch.github.io/bam-masterdata/
- Size: 3.21 MB
Statistics
- Stars: 7
- Watchers: 4
- Forks: 0
- Open Issues: 28
- Releases: 15
Topics
Metadata Files
README.md
[](https://github.com/BAMresearch/bam-masterdata/actions/workflows/actions.yml/badge.svg) [](https://coveralls.io/repos/github/BAMresearch/bam-masterdata/badge.svg?branch=main) [](https://img.shields.io/pypi/v/bam-masterdata) [](https://img.shields.io/pypi/pyversions/bam-masterdata)
The BAM Masterdata repository contains the masterdata schemas defined at BAM and provides utility functions for working with them.
If you want to install it, do:
sh
pip install bam-masterdata
Development
If you want to develop locally this package, clone the project and enter in the workspace folder:
sh
git clone https://github.com/BAMresearch/bam-masterdata.git
cd bam-masterdata
Create a virtual environment (you can use Python>3.9) in your workspace:
sh
python3 -m venv .venv
source .venv/bin/activate
Run the following script depending on your OS:
- Linux/MacOS:
sh
./scripts/install_python_dependencies.sh
- Windows:
sh
scripts/install_python_dependencies.bat
Note: This script installs the required dependencies for development, testing, and documentation, using uv and pip.
Run the tests
You can locally run the tests by doing:
sh
python -m pytest -sv tests
where the -s and -v options toggle the output verbosity.
You can also generate a local coverage report:
sh
python -m pytest --cov=src tests
Run auto-formatting and linting
We use Ruff for formatting and linting the code following the rules specified in the pyproject.toml. You can run locally:
sh
ruff check .
This will produce an output with the specific issues found. In order to auto-fix them, run:
sh
ruff format .
If some issues are not possible to fix automatically, you will need to visit the file and fix them by hand.
Documentation on Github pages
To view the documentation locally, make sure to have installed the extra packages (this is part of the scripts/install_python_dependencies.*, so if you ran this script before, you don't need to do it again now):
sh
uv pip install -e '[docu]'
Note: This command installs mkdocs, mkdocs-material, and other documentation-related dependencies.
The first time, build the server:
sh
mkdocs build
Run the documentation server:
sh
mkdocs serve
The output looks like:
sh
INFO - Building documentation...
INFO - Cleaning site directory
INFO - [14:07:47] Watching paths for changes: 'docs', 'mkdocs.yml'
INFO - [14:07:47] Serving on http://127.0.0.1:8000/
Simply click on http://127.0.0.1:8000/. The changes in the md files of the documentation are immediately reflected when the files are saved (the local web will automatically refresh).
Main contributors
The main code developers are:
| Name | E-mail | | ------------------- | ------------------------------------------------------------ | | Carlos Madariaga | carlos.madariaga@bam.de | | Dr. Jose M. Pizarro | jose.pizarro-blanco@bam.de |
Owner
- Name: Bundesanstalt für Materialforschung und -prüfung
- Login: BAMresearch
- Kind: organization
- Email: oss@bam.de
- Location: Berlin/Germany
- Website: www.bam.de
- Repositories: 36
- Profile: https://github.com/BAMresearch
German Federal scientific research institute for materials testing and research
GitHub Events
Total
- Create event: 77
- Commit comment event: 373
- Release event: 8
- Issues event: 115
- Watch event: 3
- Delete event: 56
- Member event: 1
- Issue comment event: 124
- Push event: 362
- Pull request review event: 96
- Pull request review comment event: 112
- Pull request event: 115
Last Year
- Create event: 77
- Commit comment event: 373
- Release event: 8
- Issues event: 115
- Watch event: 3
- Delete event: 56
- Member event: 1
- Issue comment event: 124
- Push event: 362
- Pull request review event: 96
- Pull request review comment event: 112
- Pull request event: 115
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 70
- Total pull requests: 63
- Average time to close issues: 18 days
- Average time to close pull requests: 1 day
- Total issue authors: 4
- Total pull request authors: 3
- Average comments per issue: 0.41
- Average comments per pull request: 0.79
- Merged pull requests: 47
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 70
- Pull requests: 63
- Average time to close issues: 18 days
- Average time to close pull requests: 1 day
- Issue authors: 4
- Pull request authors: 3
- Average comments per issue: 0.41
- Average comments per pull request: 0.79
- Merged pull requests: 47
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- JosePizarro3 (54)
- carlosmada22 (13)
- LucasZimm (2)
- jraedler (1)
Pull Request Authors
- JosePizarro3 (44)
- carlosmada22 (16)
- LucasZimm (3)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 758 last-month
- Total dependent packages: 0
- Total dependent repositories: 0
- Total versions: 15
- Total maintainers: 1
pypi.org: bam-masterdata
The BAM Data Store utility tools and masterdata models wrapped in a Python package with a front-end web interface.
- Homepage: https://github.com/BAMresearch/bam-masterdata
- Documentation: https://bamresearch.github.io/bam-masterdata/
- License: MIT License Copyright (c) 2025 Bundesanstalt für Materialforschung und -prüfung 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: 0.6.3
published 6 months ago
Rankings
Maintainers (1)
Dependencies
- actions/checkout v4 composite
- actions/setup-python v5 composite
- chartboost/ruff-action v1 composite
- actions/checkout v4 composite
- actions/setup-python v5 composite
- mhausenblas/mkdocs-deploy-gh-pages master composite
- actions/checkout v4 composite
- actions/setup-python v5 composite
- pypa/gh-action-pypi-publish release/v1 composite
- click *
- openpyxl *
- pandas *
- pybis <=1.36.3
- pydantic *