https://github.com/peppedilillo/bloodmoon
A library for analyzing data and simulations from the WFM coded mask instrument.
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 (14.7%) to scientific vocabulary
Repository
A library for analyzing data and simulations from the WFM coded mask instrument.
Basic Info
- Host: GitHub
- Owner: peppedilillo
- License: mit
- Language: Python
- Default Branch: main
- Size: 33.2 MB
Statistics
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
- Releases: 0
Metadata Files
README.md
Bloodmoon
A Python library for analyzing data from the Wide Field Monitor (WFM) coded mask instrument. Bloodmoon provides tools for: - Image reconstruction - Source detection and parameter estimation - Detector effects modeling (vignetting, PSF) - Dual-camera source localization
⚠️ Note: Bloodmoon is under active development. APIs may change between versions.
Installation
PyPI
bash
pip install bloodmoon
From Source
Installing from source is necessary when doing development work. The exact process depends on your platform but will generally require: - Git - Python 3.11 or later - pip - venv or conda (for environment management)
Using venv
```bash
Clone repository
git clone https://github.com/peppedilillo/bloodmoon.git cd bloodmoon
Create and activate virtual environment
python3 -m venv venv source venv/bin/activate # On Windows: .\venv\Scripts\activate
Install package in editable mode with development dependencies
pip install -e ".[dev]" ```
Using Conda
```bash
Clone repository
git clone https://github.com/peppedilillo/bloodmoon.git cd bloodmoon
Create and activate conda environment
conda create -n "bloodmoon" python=3.11 conda activate bloodmoon
Install package in editable mode with development dependencies
pip install -e ".[dev]" ```
Quick Start
```python import bloodmoon as bm
Load camera configuration
wfm = bm.codedmask("wfm_mask.fits")
Load simulation data
filepaths = bm.simulation_files("simdir/") sdl1a = bm.simulation(filepaths["cam1a"]["reconstructed"]) sdl1b = bm.simulation(filepaths["cam1b"]["reconstructed"])
Create detector images
detector, bins = bm.count(wfm, sdl1a.data)
Reconstruct sky image
sky = bm.decode(wfm, detector)
Run iterative source detection
for sources, residuals in bm.iros(wfm, sdl1a, sdl1b, max_iterations=10): # Process detected sources... pass ```
For more take a look at our demo.
Development
Running Tests
Assuming you installed from sources, and your source living into bloodmoon directory.
bash
cd bloodmoon
python -m unittest
Contributing
Contributions are welcome! Before submitting a pull request:
- Ensure all tests pass:
python -m unittest - Format code with black:
black -l 120 . - Sort imports with isort:
isort --profile=google .
For bug reports and feature requests, please open an issue.
Owner
- Name: Giuseppe Dilillo
- Login: peppedilillo
- Kind: user
- Location: Rome
- Company: INAF-IAPS
- Repositories: 1
- Profile: https://github.com/peppedilillo
GitHub Events
Total
- Watch event: 3
- Delete event: 3
- Issue comment event: 4
- Push event: 49
- Pull request review event: 23
- Pull request review comment event: 27
- Pull request event: 35
- Fork event: 1
- Create event: 4
Last Year
- Watch event: 3
- Delete event: 3
- Issue comment event: 4
- Push event: 49
- Pull request review event: 23
- Pull request review comment event: 27
- Pull request event: 35
- Fork event: 1
- Create event: 4
Issues and Pull Requests
Last synced: 10 months ago
All Time
- Total issues: 0
- Total pull requests: 24
- Average time to close issues: N/A
- Average time to close pull requests: 1 day
- Total issue authors: 0
- Total pull request authors: 2
- Average comments per issue: 0
- Average comments per pull request: 0.04
- Merged pull requests: 11
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 0
- Pull requests: 24
- Average time to close issues: N/A
- Average time to close pull requests: 1 day
- Issue authors: 0
- Pull request authors: 2
- Average comments per issue: 0
- Average comments per pull request: 0.04
- Merged pull requests: 11
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
Pull Request Authors
- EdoardoGiancarli (17)
- peppedilillo (5)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 18 last-month
- Total dependent packages: 0
- Total dependent repositories: 0
- Total versions: 2
- Total maintainers: 1
pypi.org: bloodmoon
A library for analyzing data and simulations from the WFM coded mask instrument.
- Homepage: https://github.com/peppedilillo/bloodmoon
- Documentation: https://bloodmoon.readthedocs.io/
- License: MIT License Copyright (c) 2025 Giuseppe Dilillo 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.1.0
published over 1 year ago
Rankings
Maintainers (1)
Dependencies
- astropy *
- matplotlib *
- numpy *
- scipy *