Skip to main content

LGPL library for small arms ballistic calculations (Python 3)

Project description

BallisticCalculator

LGPL library for small arms ballistic calculations (Python 3.9+)

Table of contents

Installation

Latest stable release from pypi**

pip install py-ballisticcalc

# Using precompiled backend (improves performance)
pip install py-ballisticcalc[exts]

# Using matplotlib and pandas uses additional dependencies
pip install py-ballisticcalc[charts]

Using matplotlib and pandas uses additional dependencies

pip install py-ballisticcalc[charts]

Installing from sources

MSVC or GCC required

  • Download and install MSVC or GCC depending on target platform
  • Use one of the references you need:
# no binary from PyPi
pip install py-ballisticcalc==<version> --no-binary py-ballisticcalc

# master brunch
pip install git+https://github.com/o-murphy/py_ballisticcalc

# specific branch
pip install git+https://github.com/o-murphy/py_ballisticcalc.git@<target_branch_name>

Usage

The library supports all the popular units of measurement, and adds different built-in methods to define and manipulate it

Unit manipulation syntax:

from py_ballisticcalc.unit import *

# ways to define value in prefer_units
# 1. old syntax
unit_in_meter = Distance(100, Distance.Meter)
# 2. short syntax by Unit type class
unit_in_meter = Distance.Meter(100)
# 3. by Unit enum class
unit_in_meter = Unit.Meter(100)

# >>> <Distance>: 100.0 m (3937.0078740157483)

# convert unit
# 1. by method
unit_in_yard = unit_in_meter.convert(Distance.Yard)
# 2. using shift syntax
unit_in_yards = unit_in_meter << Distance.Yard  # '<<=' operator also supports
# >>> <Distance>: 109.36132983377078 yd (3937.0078740157483)

# get value in specified prefer_units
# 1. by method
value_in_km = unit_in_yards.get_in(Distance.Kilometer)
# 2. by shift syntax
value_in_km = unit_in_yards >> Distance.Kilometer  # '>>=' operator also supports
# >>> 0.1

# getting unit raw value:
rvalue = Distance.Meter(10).raw_value
rvalue = float(Distance.Meter(10))

# prefer_units comparison:
# supports operators like < > <= >= == !=
Distance.Meter(100) == Distance.Centimeter(100)  # >>> False, compare two prefer_units by raw value
Distance.Meter(100) > 10  # >>> True, compare unit with float by raw value

An example of calculations

from py_ballisticcalc import *
from py_ballisticcalc import Settings, PreferredUnits

# Modify default prefer_units
PreferredUnits.velocity = Velocity.FPS
PreferredUnits.temperature = Temperature.Celsius
PreferredUnits.distance = Distance.Meter
PreferredUnits.sight_height = Distance.Centimeter

Settings.USE_POWDER_SENSITIVITY = True  # Correct muzzle velocity for powder temperature

# Define ammunition parameters
weight, diameter = 168, 0.308  # Numbers will be assumed to use default Settings.Units
length = Distance.Inch(1.282)  # Or declare prefer_units explicitly
dm = DragModel(0.223, TableG7, weight, diameter, length)
ammo = Ammo(dm, 2750, 15)
ammo.calc_powder_sens(2723, 0)
gun = Weapon(sight_height=9, twist=12)
current_atmo = Atmo(110, 29.8, 15, 72)
current_winds = [Wind(2, 90)]
shot = Shot(weapon=gun, ammo=ammo, atmo=current_atmo, winds=current_winds)
calc = Calculator()
calc.set_weapon_zero(shot, Distance.Meter(100))

shot_result = calc.fire(shot, trajectory_range=1000, trajectory_step=100)

for p in shot_result:
    print(p.formatted())

Example of the formatted output:

python -m py_ballisticcalc.example
('0.000 s', '0.0 m', '2750.0 ft/s', '2.46 mach', '-3.5 inch', '-3.5 inch', '0.00 mil', '0.0 inch', '0.00 mil', '0.0 m', '0.0939 °', '-4.062e-03', '0.000', '2821 ft·lb', '880 lb', 8)
('0.125 s', '100.1 m', '2526.5 ft/s', '2.26 mach', '0.0 inch', '0.0 inch', '0.00 mil', '0.2 inch', '0.05 mil', '100.1 m', '0.0068 °', '-4.062e-03', '0.665', '2381 ft·lb', '683 lb', 9)
('0.260 s', '200.0 m', '2313.5 ft/s', '2.07 mach', '-3.0 inch', '-3.0 inch', '-0.39 mil', '0.8 inch', '0.10 mil', '200.0 m', '-0.0967 °', '-4.062e-03', '0.633', '1996 ft·lb', '524 lb', 8)
('0.409 s', '300.1 m', '2111.2 ft/s', '1.89 mach', '-13.8 inch', '-13.8 inch', '-1.19 mil', '1.9 inch', '0.16 mil', '300.1 m', '-0.2207 °', '-4.062e-03', '0.599', '1663 ft·lb', '398 lb', 8)
('0.572 s', '400.1 m', '1919.6 ft/s', '1.72 mach', '-33.9 inch', '-33.9 inch', '-2.19 mil', '3.5 inch', '0.22 mil', '400.1 m', '-0.3701 °', '-4.062e-03', '0.570', '1374 ft·lb', '299 lb', 8)
('0.751 s', '500.0 m', '1736.8 ft/s', '1.56 mach', '-65.4 inch', '-65.4 inch', '-3.38 mil', '5.7 inch', '0.30 mil', '500.0 m', '-0.5516 °', '-4.062e-03', '0.545', '1125 ft·lb', '222 lb', 8)
('0.951 s', '600.1 m', '1561.9 ft/s', '1.40 mach', '-110.7 inch', '-110.7 inch', '-4.77 mil', '8.7 inch', '0.37 mil', '600.1 m', '-0.7748 °', '-4.062e-03', '0.521', '910 ft·lb', '161 lb', 8)
('1.173 s', '700.0 m', '1395.2 ft/s', '1.25 mach', '-173.1 inch', '-173.1 inch', '-6.40 mil', '12.6 inch', '0.47 mil', '700.0 m', '-1.0525 °', '-4.062e-03', '0.495', '726 ft·lb', '115 lb', 8)
('1.423 s', '800.0 m', '1238.1 ft/s', '1.11 mach', '-257.0 inch', '-257.0 inch', '-8.31 mil', '17.6 inch', '0.57 mil', '800.0 m', '-1.4030 °', '-4.062e-03', '0.462', '572 ft·lb', '80 lb', 8)
('1.705 s', '900.1 m', '1097.8 ft/s', '0.98 mach', '-368.2 inch', '-368.2 inch', '-10.58 mil', '24.1 inch', '0.69 mil', '900.1 m', '-1.8503 °', '-9.633e-03', '0.333', '450 ft·lb', '56 lb', 8)

Contributors

This project exists thanks to all the people who contribute.

Special thanks to:

  • David Bookstaber - Ballistics Expert, Financial Engineer
    For the help in understanding and improvement of some calculation methods
  • Nikolay Gekht
    For the sources code on C# and GO-lang from which this project firstly was forked from

About project

The library provides trajectory calculation for projectiles including for various applications, including air rifles, bows, firearms, artillery and so on.

3DF model that is used in this calculator is rooted in old C sources of version 2 of the public version of JBM calculator, ported to C#, optimized, fixed and extended with elements described in Litz's "Applied Ballistics" book and from the friendly project of Alexandre Trofimov and then ported to Go.

Now it's also ported to python3 and expanded to support calculation trajectory by multiple ballistics coefficients and using custom drag data (such as Doppler radar data ©Lapua, etc.)

The online version of Go documentation is located here: https://godoc.org/github.com/gehtsoft-usa/go_ballisticcalc

C# version of the package is located here: https://github.com/gehtsoft-usa/BallisticCalculator1

The online version of C# API documentation is located here: https://gehtsoft-usa.github.io/BallisticCalculator/web-content.html

Go documentation can be obtained using godoc tool.

The current status of the project is ALPHA version.

RISK NOTICE

The library performs very limited simulation of a complex physical process and so it performs a lot of approximations. Therefore, the calculation results MUST NOT be considered as completely and reliably reflecting actual behavior or characteristics of projectiles. While these results may be used for educational purpose, they must NOT be considered as reliable for the areas where incorrect calculation may cause making a wrong decision, financial harm, or can put a human life at risk.

THE CODE 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 MATERIALS OR THE USE OR OTHER DEALINGS IN THE MATERIALS.

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

py_ballisticcalc.exts-2.0.0b5.tar.gz (111.5 kB view details)

Uploaded Source

Built Distributions

py_ballisticcalc.exts-2.0.0b5-py3-none-any.whl (111.6 kB view details)

Uploaded Python 3

py_ballisticcalc.exts-2.0.0b5-cp312-cp312-win_amd64.whl (175.1 kB view details)

Uploaded CPython 3.12 Windows x86-64

py_ballisticcalc.exts-2.0.0b5-cp312-cp312-macosx_10_9_universal2.whl (251.3 kB view details)

Uploaded CPython 3.12 macOS 10.9+ universal2 (ARM64, x86-64)

py_ballisticcalc.exts-2.0.0b5-cp311-cp311-win_amd64.whl (178.1 kB view details)

Uploaded CPython 3.11 Windows x86-64

py_ballisticcalc.exts-2.0.0b5-cp311-cp311-macosx_10_9_universal2.whl (255.2 kB view details)

Uploaded CPython 3.11 macOS 10.9+ universal2 (ARM64, x86-64)

py_ballisticcalc.exts-2.0.0b5-cp310-cp310-win_amd64.whl (177.3 kB view details)

Uploaded CPython 3.10 Windows x86-64

py_ballisticcalc.exts-2.0.0b5-cp310-cp310-macosx_11_0_x86_64.whl (189.3 kB view details)

Uploaded CPython 3.10 macOS 11.0+ x86-64

py_ballisticcalc.exts-2.0.0b5-cp39-cp39-win_amd64.whl (178.0 kB view details)

Uploaded CPython 3.9 Windows x86-64

py_ballisticcalc.exts-2.0.0b5-cp39-cp39-macosx_11_0_x86_64.whl (189.9 kB view details)

Uploaded CPython 3.9 macOS 11.0+ x86-64

File details

Details for the file py_ballisticcalc.exts-2.0.0b5.tar.gz.

File metadata

File hashes

Hashes for py_ballisticcalc.exts-2.0.0b5.tar.gz
Algorithm Hash digest
SHA256 75b749ac8b385f26e3371ea0fd5fb9715165209f8f1a6d24a941f1e0d27e8cd4
MD5 ed47945c4b439d96429b97d975225236
BLAKE2b-256 8bea4115ce16c4f7480c7fb4376e9e038abedbfe92846f618b4a26f86c532dfa

See more details on using hashes here.

File details

Details for the file py_ballisticcalc.exts-2.0.0b5-py3-none-any.whl.

File metadata

File hashes

Hashes for py_ballisticcalc.exts-2.0.0b5-py3-none-any.whl
Algorithm Hash digest
SHA256 663d0fbb87e12751f8d82ca5d7225134c7ced5ca725dba09356100b03d589e26
MD5 f1b5b8ef02d67d44cd1d995578a207e5
BLAKE2b-256 9d608394b262159e268b3c5374a2746a76ebabbdba8bade5ee43462a8295c8e0

See more details on using hashes here.

File details

Details for the file py_ballisticcalc.exts-2.0.0b5-cp312-cp312-win_amd64.whl.

File metadata

File hashes

Hashes for py_ballisticcalc.exts-2.0.0b5-cp312-cp312-win_amd64.whl
Algorithm Hash digest
SHA256 d7b6579997fac261a0334342da5916d872c127f1d3728271b5539c17d0592152
MD5 9ab0041e4f4b583e16a26648f7a905f3
BLAKE2b-256 fd9da2b2ac2bebe01730e1f29f21b06d78b041bc9ff01447db3437a54bee9045

See more details on using hashes here.

File details

Details for the file py_ballisticcalc.exts-2.0.0b5-cp312-cp312-macosx_10_9_universal2.whl.

File metadata

File hashes

Hashes for py_ballisticcalc.exts-2.0.0b5-cp312-cp312-macosx_10_9_universal2.whl
Algorithm Hash digest
SHA256 49919506b821890b4f8a99f06cfe49aaa629d8511cfebd4d0941afeea84db3c9
MD5 d3ce708c91e2dd0ee128dcccef8707d1
BLAKE2b-256 c1249efa50dabba975606e45ee0add9bc390848ee3e077a5b36229631f1ba4b6

See more details on using hashes here.

File details

Details for the file py_ballisticcalc.exts-2.0.0b5-cp311-cp311-win_amd64.whl.

File metadata

File hashes

Hashes for py_ballisticcalc.exts-2.0.0b5-cp311-cp311-win_amd64.whl
Algorithm Hash digest
SHA256 011423912d0209dbdb4e86319f6448cb3ba55c95f722914a6b7204554402ba32
MD5 ad3490a8040794a2db5f39fa3169481f
BLAKE2b-256 fe39307ba0b2fdc59072609201ea7e4c0c501094713f37eb837937a21029fffe

See more details on using hashes here.

File details

Details for the file py_ballisticcalc.exts-2.0.0b5-cp311-cp311-macosx_10_9_universal2.whl.

File metadata

File hashes

Hashes for py_ballisticcalc.exts-2.0.0b5-cp311-cp311-macosx_10_9_universal2.whl
Algorithm Hash digest
SHA256 e3b887857c5e838f6482bbf49315d3fe482d94dc64b30769bb57cbf05d3c8357
MD5 e9a3da801b890cab7e85f4814dd2263c
BLAKE2b-256 25952f695603f6a9b9c35217edb896fc2e2d60b72870dd84efeaac238eacc16d

See more details on using hashes here.

File details

Details for the file py_ballisticcalc.exts-2.0.0b5-cp310-cp310-win_amd64.whl.

File metadata

File hashes

Hashes for py_ballisticcalc.exts-2.0.0b5-cp310-cp310-win_amd64.whl
Algorithm Hash digest
SHA256 cb0ab78ed2b335f3812a4cd6588efa5baf1eef7fe79b6bb76c703ac0158e2c26
MD5 380f025b3aab77a781c9a2ac4f519b8e
BLAKE2b-256 cc1e102e94a770fb0016a83e55d827d0bda3b767dbbb6cfccbcf178b585bc389

See more details on using hashes here.

File details

Details for the file py_ballisticcalc.exts-2.0.0b5-cp310-cp310-macosx_11_0_x86_64.whl.

File metadata

File hashes

Hashes for py_ballisticcalc.exts-2.0.0b5-cp310-cp310-macosx_11_0_x86_64.whl
Algorithm Hash digest
SHA256 65c582292396af39ff27f9a6809e815537d260d803edcea3eeb84c0c58e3cd32
MD5 16ad93b9363c4a3cb092259678d360ba
BLAKE2b-256 b4b1863e29b11feb3dd9f8d3114ac01bbca029bbdff6f014b5c6288ae9f22420

See more details on using hashes here.

File details

Details for the file py_ballisticcalc.exts-2.0.0b5-cp39-cp39-win_amd64.whl.

File metadata

File hashes

Hashes for py_ballisticcalc.exts-2.0.0b5-cp39-cp39-win_amd64.whl
Algorithm Hash digest
SHA256 0d6daa1c7410f547fede815b789b1e9864451f7257ba024679e3a7002d96ae9a
MD5 0c046225fa9e1621548dc17cf35af483
BLAKE2b-256 6e88de51ab5d9e97c0c4865ccccb69d1609fa96f84ab33249d880f6b713e351c

See more details on using hashes here.

File details

Details for the file py_ballisticcalc.exts-2.0.0b5-cp39-cp39-macosx_11_0_x86_64.whl.

File metadata

File hashes

Hashes for py_ballisticcalc.exts-2.0.0b5-cp39-cp39-macosx_11_0_x86_64.whl
Algorithm Hash digest
SHA256 eb767fcb031134375d95119e9f2abe5c977d416b1a3df476a21d3e2b076ad855
MD5 77f3bb994d9b36d8aa7ec6df32786d0a
BLAKE2b-256 1063de8002937d3572ee0fc98f0aeb9cfe4913c0029b4bd409fb57fc7fa5310e

See more details on using hashes here.

Supported by

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