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

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>

Clone and build

MSVC or GCC required

git clone https://github.com/o-murphy/py_ballisticcalc
cd py_ballisticcalc
python -m venv venv
. venv/bin/activate
pip install cython
python setup.py build_ext --inplace

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 Velocity, Temperature, Distance
from py_ballisticcalc import DragModel, TableG7
from py_ballisticcalc import Ammo, Atmo, Wind
from py_ballisticcalc import Weapon, Shot, Calculator
from py_ballisticcalc import Settings as Set


# set global library settings
Set.Units.velocity = Velocity.FPS
Set.Units.temperature = Temperature.Celsius
# Set.Units.distance = Distance.Meter
Set.Units.sight_height = Distance.Centimeter

Set.set_max_calc_step_size(Distance.Foot(1))
Set.USE_POWDER_SENSITIVITY = True  # enable muzzle velocity correction my powder temperature

# define params with default units
weight, diameter = 168, 0.308
# or define with specified units
length = Distance.Inch(1.282)  # length = Distance(1.282, Distance.Inch)

weapon = Weapon(9, 100, 2)
dm = DragModel(0.223, TableG7, weight, diameter)

ammo = Ammo(dm, length, 2750, 15)
ammo.calc_powder_sens(2723, 0)

zero_atmo = Atmo.icao(100)

# defining calculator instance
calc = Calculator(weapon, ammo, zero_atmo)

current_atmo = Atmo(110, 1000, 15, 72)
current_winds = [Wind(2, 90)]
shot = Shot(1500, atmo=current_atmo, winds=current_winds)

shot_result = calc.fire(shot, trajectory_step=Distance.Yard(100))

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

Example of the formatted output:

python -m py_ballisticcalc.example
['0.00 s', '0.000 m', '2750.0 ft/s', '2.46 mach', '-9.000 cm', '0.00 mil', '0.000 cm', '0.00 mil', '3825 J']
['0.12 s', '100.000 m', '2528.6 ft/s', '2.26 mach', '0.005 cm', '0.00 mil', '-3.556 cm', '-0.36 mil', '3233 J']
['0.26 s', '200.050 m', '2317.2 ft/s', '2.08 mach', '-7.558 cm', '-0.38 mil', '-13.602 cm', '-0.69 mil', '2715 J']
['0.41 s', '300.050 m', '2116.6 ft/s', '1.90 mach', '-34.843 cm', '-1.18 mil', '-30.956 cm', '-1.05 mil', '2266 J']
['0.57 s', '400.000 m', '1926.5 ft/s', '1.73 mach', '-85.739 cm', '-2.18 mil', '-57.098 cm', '-1.45 mil', '1877 J']
['0.75 s', '500.000 m', '1745.0 ft/s', '1.56 mach', '-165.209 cm', '-3.37 mil', '-94.112 cm', '-1.92 mil', '1540 J']
['0.95 s', '600.000 m', '1571.4 ft/s', '1.41 mach', '-279.503 cm', '-4.74 mil', '-144.759 cm', '-2.46 mil', '1249 J']

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-1.1.4.tar.gz (197.3 kB view details)

Uploaded Source

Built Distributions

py_ballisticcalc.exts-1.1.4-py3-none-any.whl (202.8 kB view details)

Uploaded Python 3

py_ballisticcalc.exts-1.1.4-cp312-cp312-win_amd64.whl (311.5 kB view details)

Uploaded CPython 3.12 Windows x86-64

py_ballisticcalc.exts-1.1.4-cp312-cp312-macosx_10_9_universal2.whl (440.2 kB view details)

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

py_ballisticcalc.exts-1.1.4-cp311-cp311-win_amd64.whl (315.4 kB view details)

Uploaded CPython 3.11 Windows x86-64

py_ballisticcalc.exts-1.1.4-cp311-cp311-macosx_10_9_universal2.whl (446.5 kB view details)

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

py_ballisticcalc.exts-1.1.4-cp310-cp310-win_amd64.whl (314.7 kB view details)

Uploaded CPython 3.10 Windows x86-64

py_ballisticcalc.exts-1.1.4-cp310-cp310-macosx_11_0_x86_64.whl (331.6 kB view details)

Uploaded CPython 3.10 macOS 11.0+ x86-64

py_ballisticcalc.exts-1.1.4-cp39-cp39-win_amd64.whl (315.4 kB view details)

Uploaded CPython 3.9 Windows x86-64

py_ballisticcalc.exts-1.1.4-cp39-cp39-macosx_11_0_x86_64.whl (332.6 kB view details)

Uploaded CPython 3.9 macOS 11.0+ x86-64

File details

Details for the file py_ballisticcalc.exts-1.1.4.tar.gz.

File metadata

  • Download URL: py_ballisticcalc.exts-1.1.4.tar.gz
  • Upload date:
  • Size: 197.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.18

File hashes

Hashes for py_ballisticcalc.exts-1.1.4.tar.gz
Algorithm Hash digest
SHA256 0cc5c85e95e2aec5bd6932cc302b73cdf0909844ac82348ab456cc352faa313d
MD5 51124c22ab174005390c955e5003cb5a
BLAKE2b-256 b8f2b8be183e7c0d620a02a34bdfd9112ba49870eb9f4fb2784b35c64489817a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for py_ballisticcalc.exts-1.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 af7934db614649163072709ac600d5a3fc0ee9aa729514ef991ad18fec7b054e
MD5 0db9ad7113577631eb640026a639c135
BLAKE2b-256 410d244d674759f2a70eae4b2df83bf512080ada02aad2ec71f804c49af71ae5

See more details on using hashes here.

File details

Details for the file py_ballisticcalc.exts-1.1.4-cp312-cp312-win_amd64.whl.

File metadata

File hashes

Hashes for py_ballisticcalc.exts-1.1.4-cp312-cp312-win_amd64.whl
Algorithm Hash digest
SHA256 f74fae4ca376efd336bf5efa17d06dc268b2e9ed7f5c21a8367970de4f31f9ca
MD5 9ed4886e931c83408377b32845871ef9
BLAKE2b-256 d70e60119d2840e0386613533be6bcc55cdba0acf0bad3d37b901e762ee88875

See more details on using hashes here.

File details

Details for the file py_ballisticcalc.exts-1.1.4-cp312-cp312-macosx_10_9_universal2.whl.

File metadata

File hashes

Hashes for py_ballisticcalc.exts-1.1.4-cp312-cp312-macosx_10_9_universal2.whl
Algorithm Hash digest
SHA256 1278ee1b2805a1f6710a8fa43129e5ccd8a7c9c95027f458c806c988221cbb4e
MD5 d3210abc951b6a24d6915d0218601f7b
BLAKE2b-256 40a71ef272e6085b72f616a36c20e803b49663df933668dc39a01d309641a9f9

See more details on using hashes here.

File details

Details for the file py_ballisticcalc.exts-1.1.4-cp311-cp311-win_amd64.whl.

File metadata

File hashes

Hashes for py_ballisticcalc.exts-1.1.4-cp311-cp311-win_amd64.whl
Algorithm Hash digest
SHA256 9791b3d7996b9ad1687cd9e7e5aa99a248a23583ba6101181b9d9b7b7ad468dc
MD5 9c32de1098bbb85899a0247fd1be0974
BLAKE2b-256 7b0bc6b8e1b0df9e6131a548e643e1df5aafe60d407851c4b121eea8a05602f4

See more details on using hashes here.

File details

Details for the file py_ballisticcalc.exts-1.1.4-cp311-cp311-macosx_10_9_universal2.whl.

File metadata

File hashes

Hashes for py_ballisticcalc.exts-1.1.4-cp311-cp311-macosx_10_9_universal2.whl
Algorithm Hash digest
SHA256 e77e37ff31378062064e676d9af61394fd15754557ed26fed33ab7fb9757ac91
MD5 4bf06e52a5f9f4a3f3d2c4d5fdaa9971
BLAKE2b-256 a7e058516dd3aedc91f78d6e858681b0ccba5d7090c10870643450053a86322e

See more details on using hashes here.

File details

Details for the file py_ballisticcalc.exts-1.1.4-cp310-cp310-win_amd64.whl.

File metadata

File hashes

Hashes for py_ballisticcalc.exts-1.1.4-cp310-cp310-win_amd64.whl
Algorithm Hash digest
SHA256 51195cee1fc19b3b01492f4348a421ed45e28a48baac5ac1d57168c0b364c0f4
MD5 0f38b68944819c7b026f2e1fc1cade66
BLAKE2b-256 22f050b0cb9761cb88c6308179c2cfb896862aba55e7ae1c1b5322dac74960a6

See more details on using hashes here.

File details

Details for the file py_ballisticcalc.exts-1.1.4-cp310-cp310-macosx_11_0_x86_64.whl.

File metadata

File hashes

Hashes for py_ballisticcalc.exts-1.1.4-cp310-cp310-macosx_11_0_x86_64.whl
Algorithm Hash digest
SHA256 928dead3c91f0db2a8616d9cc9ee9895e5699c387a9020c11f0f9cd206ab3f06
MD5 6624785785ed66e6490af6915da00e44
BLAKE2b-256 9c2ffef31c5dc06323dd6e1e2d7d7cde3559e229dddb518758014dffe60f9ced

See more details on using hashes here.

File details

Details for the file py_ballisticcalc.exts-1.1.4-cp39-cp39-win_amd64.whl.

File metadata

File hashes

Hashes for py_ballisticcalc.exts-1.1.4-cp39-cp39-win_amd64.whl
Algorithm Hash digest
SHA256 9f57afef8cc0b46173829dc3e404f7eac65ab26e64f0a65fcea2353d32d18bbe
MD5 1cc91106a6dd80007fd36aebbc9d5c1b
BLAKE2b-256 4b783cf6d62d665376ab696f9c37c4537791b7b518ad6990db7ce2538a43e3d2

See more details on using hashes here.

File details

Details for the file py_ballisticcalc.exts-1.1.4-cp39-cp39-macosx_11_0_x86_64.whl.

File metadata

File hashes

Hashes for py_ballisticcalc.exts-1.1.4-cp39-cp39-macosx_11_0_x86_64.whl
Algorithm Hash digest
SHA256 6f2d5929f54814f2b05737774662f31c3856756183691975a2b9c62108bcd140
MD5 a98ca656a2a33c4d30318b496eceb8a9
BLAKE2b-256 9910488deccf2adc800a38a9f6a844ab9ef134149232fb57e2cf943b2ed4693e

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