gcmicrolensing
Tools for simulating gravitational microlensing events with single, binary, and triple lens systems. This package is under active development.
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
-
○Committers with academic emails
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (15.0%) to scientific vocabulary
Keywords
Repository
Tools for simulating gravitational microlensing events with single, binary, and triple lens systems. This package is under active development.
Basic Info
- Host: GitHub
- Owner: GCMicrolensing-Org
- License: mit
- Language: Jupyter Notebook
- Default Branch: main
- Homepage: https://gcmicrolensing.readthedocs.io/en/latest/
- Size: 162 MB
Statistics
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
- Releases: 2
Topics
Metadata Files
README.md
GCMicrolensing
Tools for simulating gravitational microlensing events with single, binary, and triple lens systems. This package is under active development.
Installation
Prerequisites
This package requires a custom version of TripleLensing with modifications by Gregory Costa Cuautle. The installation process depends on how you obtained this package:
Option 1: From Source (Recommended)
If you cloned this repository, the custom TripleLensing is included and will be installed automatically:
bash
git clone https://github.com/GCMicrolensing-Org/GCMicrolensing.git
cd GCMicrolensing
pip install -e .
Option 2: Manual Installation
If you're installing from a distribution that doesn't include TripleLensing, you'll need to install it manually:
```bash
First install GCMicrolensing
pip install GCMicrolensing
Then install the custom TripleLensing (instructions to be provided)
This requires the custom version with Greg's modifications
```
Usage
```python from GCMicrolensing import OneL1S, TwoLens1S, ThreeLens1S
Create a single lens model
model = OneL1S(t0=2450000, tE=20, rho=0.001, u0list=[0.1, 0.5, 1.0]) model.plotlight_curve() ```
Dependencies
- TripleLensing: Custom version with modifications by Gregory Costa Cuautle
- VBMicrolensing: For binary lens calculations
- Standard scientific Python stack: numpy, matplotlib, scipy, astropy, etc.
Documentation
See the docs/ directory for detailed documentation.
This project uses a regular Python packaging workflow. To install the
package and its minimal runtime dependencies, execute::
pip install .
The local TripleLensing library will be built and installed
automatically as part of this process.
For development a more feature rich environment can be created using the
environment.yml file.
Owner
- Name: GCM
- Login: GCMicrolensing-Org
- Kind: organization
- Email: malpas.1@osu.edu
- Location: United States of America
- Repositories: 1
- Profile: https://github.com/GCMicrolensing-Org
GitHub Events
Total
- Push event: 3
- Create event: 1
Last Year
- Push event: 3
- Create event: 1
Issues and Pull Requests
Last synced: 7 months ago
Dependencies
- actions/checkout v4 composite
- actions/setup-python v5 composite
- actions/checkout v4 composite
- actions/setup-python v5 composite
- pypa/gh-action-pypi-publish release/v1 composite
- softprops/action-gh-release v1 composite