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 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 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))

# units comparison:
# supports operators like < > <= >= == !=
Distance.Meter(100) == Distance.Centimeter(100)  # >>> False, compare two 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 as Set

# Modify default units
Set.Units.velocity = Velocity.FPS
Set.Units.temperature = Temperature.Celsius
Set.Units.distance = Distance.Meter
Set.Units.sight_height = Distance.Centimeter

Set.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 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.0b0.tar.gz (201.8 kB view details)

Uploaded Source

Built Distributions

py_ballisticcalc.exts-2.0.0b0-py3-none-any.whl (207.2 kB view details)

Uploaded Python 3

py_ballisticcalc.exts-2.0.0b0-cp312-cp312-win_amd64.whl (319.4 kB view details)

Uploaded CPython 3.12 Windows x86-64

py_ballisticcalc.exts-2.0.0b0-cp312-cp312-macosx_10_9_universal2.whl (450.5 kB view details)

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

py_ballisticcalc.exts-2.0.0b0-cp311-cp311-win_amd64.whl (322.6 kB view details)

Uploaded CPython 3.11 Windows x86-64

py_ballisticcalc.exts-2.0.0b0-cp311-cp311-macosx_10_9_universal2.whl (455.4 kB view details)

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

py_ballisticcalc.exts-2.0.0b0-cp310-cp310-win_amd64.whl (322.0 kB view details)

Uploaded CPython 3.10 Windows x86-64

py_ballisticcalc.exts-2.0.0b0-cp310-cp310-macosx_11_0_x86_64.whl (338.4 kB view details)

Uploaded CPython 3.10 macOS 11.0+ x86-64

py_ballisticcalc.exts-2.0.0b0-cp39-cp39-win_amd64.whl (322.7 kB view details)

Uploaded CPython 3.9 Windows x86-64

py_ballisticcalc.exts-2.0.0b0-cp39-cp39-macosx_11_0_x86_64.whl (339.3 kB view details)

Uploaded CPython 3.9 macOS 11.0+ x86-64

File details

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

File metadata

File hashes

Hashes for py_ballisticcalc.exts-2.0.0b0.tar.gz
Algorithm Hash digest
SHA256 03c70d54f8d49722d988b5525bc5d6a895c7a6e64824ccd0eb119f95892cefaf
MD5 abbe7280b01d82e2f4bf306dc9ca5d9c
BLAKE2b-256 d527d016095958b07fcbabea59a360f358d52e2a049047171db264b3c948034c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for py_ballisticcalc.exts-2.0.0b0-py3-none-any.whl
Algorithm Hash digest
SHA256 dd63da7762bff9d06cdbf4846dad7fc6d3ba40133cce3065f2c7dc032f3e61fa
MD5 cb261b4857ee65b80649f0533239794e
BLAKE2b-256 54399d220daae49e85ab8b81f486f2b608a02a7ea12184dbc2c776a756803d99

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for py_ballisticcalc.exts-2.0.0b0-cp312-cp312-win_amd64.whl
Algorithm Hash digest
SHA256 d5f91f8fe3173f6ec42f8342b909b301df7c7424bf0804554113b5867194b78e
MD5 4b534a77c08e441eaa3ec0180d6322db
BLAKE2b-256 70ebff9fbf033372308c7d31931fa748944f3f3c0a9560d4a1df8d7f491df218

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for py_ballisticcalc.exts-2.0.0b0-cp312-cp312-macosx_10_9_universal2.whl
Algorithm Hash digest
SHA256 b6738acb765d8aa6847ffa8b5f4bcff0be7a9fa4d9a6aff5ee5477a02148a9f5
MD5 028088f0ce53b2d36a5df97fffddf351
BLAKE2b-256 34ddc6662e030e729ff643fa291e76ec108a2a694a083874e742d22e80214fa4

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for py_ballisticcalc.exts-2.0.0b0-cp311-cp311-win_amd64.whl
Algorithm Hash digest
SHA256 03ff099bb2e54a7da3215341828dc3d6a1c75c5ccb7eb0c09973c79e5ee468d4
MD5 a0ff3ff91eaaac08959224391fe9fc47
BLAKE2b-256 6ccf02f2b96272e0963cb4aaf4c72d7c91d075a87ca7079f0648b724e3d1a3a4

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for py_ballisticcalc.exts-2.0.0b0-cp311-cp311-macosx_10_9_universal2.whl
Algorithm Hash digest
SHA256 cee2acc166f5cb942c7d2249a8b96bae520f80ad6dabafb2bfe4e8dcfe6c6258
MD5 e08aa6e1ea4d72eff4985a89b224afd7
BLAKE2b-256 f01fd0497875d117d238554482b999ed44438605fff894c34ca6cd530221be77

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for py_ballisticcalc.exts-2.0.0b0-cp310-cp310-win_amd64.whl
Algorithm Hash digest
SHA256 a90342837595111f00440473ed36a5c569e9a9acbf1a59cf68bed4f20e870756
MD5 96ca49908784913b967043b598167ba0
BLAKE2b-256 67c286eb9b426be85810deac3bab7966fe597539a34cea251ccd6f28fc78f745

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for py_ballisticcalc.exts-2.0.0b0-cp310-cp310-macosx_11_0_x86_64.whl
Algorithm Hash digest
SHA256 9d4330d1ea51938e61d48ee8349b3a7998d7535cc4733b5b09da3882c60a9aa8
MD5 2e8ad5442784317cf7cf2085e1ab15c5
BLAKE2b-256 8b213394f55f1b96611a578868064e8d47b6af7709c336b7bb053505e0ef2b61

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for py_ballisticcalc.exts-2.0.0b0-cp39-cp39-win_amd64.whl
Algorithm Hash digest
SHA256 4520d0f56400de3be5d30b194caeb31f9a1c37638aff21407519ac6549e124b0
MD5 450f91bdc5c6e3b146c777cd1619b855
BLAKE2b-256 e2fc5687f2b79fa2d6da0c995f98811f0769e53dfe717e071552bdf8e771524a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for py_ballisticcalc.exts-2.0.0b0-cp39-cp39-macosx_11_0_x86_64.whl
Algorithm Hash digest
SHA256 c01a3025369d6513f10e385f360cbdc3803f3309f4aed81e7518e51f9a7a8d12
MD5 85d4cdb252331f5c713f1f839dd19985
BLAKE2b-256 c6a6f0090149c352d23c8eca3417a3e2f073899adbc1e1c5240aa9af331592c5

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