Skip to main content

A Python package for generating spectral channel maps of a jet-driven bowshock model

Project description

BowshockPy

A Python package for generating spectral channel maps of a jet-driven bowshock model

PyPI - Version PyPI - Python Version PyPI license Tests codecov Documentation Status

BowshockPy is a Python package that generates synthetic spectral cubes, position-velocity diagrams, and moment images for a simple analytical jet-driven bowshock model, using the prescription for protostellar jets presented in Ostriker et al. (2001) and Tabone et al. (2018). The software computes column density and is able to calculate the intensities of low-J rotational transitions of a linear molecule such as CO, providing mock observations of the emission that radio interferometers as ALMA are able to detect at millimeter wavelengths.

Documentation

An extensive documentation on BowshockPy can be found here.

Requirements

BowshockPy requires:

  • astropy
  • matplotlib
  • numpy
  • photutils
  • scipy

It has been tested in python versions 3.9-3.12, but it could work with other versions also.

Installation

You can install BowshockPy from PyPI.

$ pip install bowshockpy

How to use

There are two different ways to use BowshockPy:

  1. Run it from the terminal specifying an input file: Use an example of input file and modify the input parameters according your scientific goals. Then, run BowshockPy in your terminal:
$ bowshockpy -r inputfile.py
  1. Import BowshockPy package in your Python code: We include an notebook tutorial that shows how to use the main classes.

See the documentation for more details on the usage of BowshockPy.

Contributing

If you are interested in contributing, see contributing

License

This project is licensed under the MIT License. For details see the LICENSE.

Citation

@software{gblazquez2025,
  author    = {Blazquez-Calero, Guillermo AND et al.},
  title     = {{BowshockPy}: A Python package for the generation of synthetic spectral channel maps of a jet-driven
bowshock model},
  year      = {2025},
  version   = {1.0.0},
  url       = {https://github.com/gblazquez/bowshockpy}
}

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bowshockpy-1.0.0.tar.gz (62.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

bowshockpy-1.0.0-py3-none-any.whl (94.8 kB view details)

Uploaded Python 3

File details

Details for the file bowshockpy-1.0.0.tar.gz.

File metadata

  • Download URL: bowshockpy-1.0.0.tar.gz
  • Upload date:
  • Size: 62.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for bowshockpy-1.0.0.tar.gz
Algorithm Hash digest
SHA256 311bf879ad364ba097569205ae62823c66a04997cccccd28714d77d1837fd8f8
MD5 69147f8817cc639b5793561aad6eb998
BLAKE2b-256 3b07e15b8ce64f500dda0205b9ec826b4d3658bdf6954df715b8009509d8f8f9

See more details on using hashes here.

File details

Details for the file bowshockpy-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: bowshockpy-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 94.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for bowshockpy-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1f89e209f5e9648549fbfdb40d230de4bdba51f9974075f04010e89b341e84ac
MD5 1bed2c5b6096d438501b069c50387112
BLAKE2b-256 8f544ed03860a9f3ac75a6ccad6cf225a61594c7c2536b571b96f851703a5e0f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page