Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

Python 3.12 Documentation Status PyPI version GitHub release GitHub Codacy Badge astropy

EclipsingBinaries

EclipsingBinaries is a Python project for faster analysis of eclipsing binary star systems. The package can currently reduce data, find comparison stars from the APASS catalog, calculate and plot O-C values, find the color index and effective temperature, O’Connell effect parameters, download TESS data, and perform interactive multi-aperture photometry with auto-suggested, optimized radii.


Documentation

You can find the documentation at this site and any questions can be talked about in the discussions page or in an issue.


OS and Python Versions Stable On

The list of OS’s and Python versions listed below have been tested to be able to build the package on.

  • Macos- 3.12
  • Ubuntu- 3.12
  • Windows- 3.12

The minimum working Python version is 3.12 and as of right now no versions lower work with all aspects of this package.

The GUI uses tkinter, which some Python installs leave out:

  • macOS with Homebrew Python: brew install python-tk@3.12 (match your Python version). The python.org installer already includes it.
  • Windows: the python.org installer includes it as long as "tcl/tk and IDLE" stays checked.
  • Ubuntu/Debian: install the system package before starting the app:
sudo apt install python3-tk

Drag and drop works with both Tk 8.6 and Tk 9. If it can't load (for example an Intel Mac running Tk 9), the app still starts and the Browse buttons work as usual.


Installation and Usage

To install type the following,

pip install EclipsingBinaries

Once installed, in the command line type the following:

EclipsingBinaries

This opens the GUI, which has every program in one window. Programs run in the background with a Cancel button, and file and folder fields accept drag and drop. See Running EclipsingBinaries for details.

To check the version you have,

pip show EclipsingBinaries

this will show numerous things, but you want to look at the version and make sure it is up to date.

If your version is not the most recent version then in order to update type the following,

pip install --upgrade EclipsingBinaries

Pipeline

To use the pipeline functionality type the following:

EB_pipeline -h

This prints every available option. A typical run looks like:

EB_pipeline raw_images/ reduced_images/ --ra 00:28:27.96 --dec 78:57:42.65 --name NSVS_254037 --loc BSUO

The input and output folders and --ra, --dec and --name are required. See the pipeline docs for the rest.


Dependencies

  • python >=3.12
  • astropy>=6.0
  • astroquery>=0.4.6
  • ccdproc>=2.4.0
  • matplotlib>=3.8.0
  • numpy>=1.26
  • pandas>=2.1.1
  • PyAstronomy>=0.18.1
  • scipy>=1.11.2
  • statsmodels>=0.14
  • tqdm>=4.64.1
  • pyia>=1.4
  • photutils>=1.8.0
  • tkinterdnd2>=0.6.1
  • tkinter for the GUI (see the notes above)

pip installs everything except tkinter. pyproject.toml has the authoritative list.


Development

git clone https://github.com/kjkoeller/EclipsingBinaries.git
cd EclipsingBinaries
pip install -e ".[test,docs]"
pytest

The tests run without an internet connection. See the contributing guide for more.


License

EclipsingBinaries is released under the Creative Commons Attribution-NonCommercial 4.0 International license. See LICENSE for the full text.

Metadata

Release files for EclipsingBinaries 5.0.0a20

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for EclipsingBinaries 5.0.0a20
File Size Uploaded
eclipsingbinaries-5.0.0a20.tar.gz 1.0 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for EclipsingBinaries 5.0.0a20
File Interpreter ABI Platform
eclipsingbinaries-5.0.0a20-py3-none-any.whl Python 3 none any Details

Total release size: 2.0 MB

Release files / eclipsingbinaries-5.0.0a20.tar.gz

Download URL eclipsingbinaries-5.0.0a20.tar.gz
Size 1.0 MB
Tags Source
SHA-256 checksum
How to use checksums
4b565eba20569fc920208c8d16e6bb61001dd989978241b55db5b52e6f2291da
BLAKE2b-256 checksum
How to use checksums
9f1613dc2bd138c8aac50ab8c217390da6d3ccdbe3ec4e0f21ef8adfa0c570a1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.14

Release files / eclipsingbinaries-5.0.0a20-py3-none-any.whl

Download URL eclipsingbinaries-5.0.0a20-py3-none-any.whl
Size 918.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
2b371fe054a7e97498777005fb2a47d16da42e28ba10a6ae2b99ec812adf3f74
BLAKE2b-256 checksum
How to use checksums
b132eb0cc913ecb9f29862299cde72ce635d704d5909860ec1810800add761cd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.14

Release history Release notifications | RSS feed

This release

5.0.0a20 This release

2 release files

4.1.4

2 release files

4.1.3

2 release files

4.1.2

2 release files

4.1.1

2 release files

4.1.0

2 release files

4.0.8

2 release files

4.0.7

2 release files

4.0.6

2 release files

4.0.5

2 release files

4.0.3

2 release files

4.0.2

2 release files

4.0.1

2 release files

4.0.0

2 release files

0.0.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page