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

Uploaded Source

Built Distributions

py_ballisticcalc.exts-1.1.0-py3-none-any.whl (200.3 kB view details)

Uploaded Python 3

py_ballisticcalc.exts-1.1.0-cp312-cp312-win_amd64.whl (309.3 kB view details)

Uploaded CPython 3.12 Windows x86-64

py_ballisticcalc.exts-1.1.0-cp312-cp312-macosx_10_9_universal2.whl (436.7 kB view details)

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

py_ballisticcalc.exts-1.1.0-cp311-cp311-win_amd64.whl (312.4 kB view details)

Uploaded CPython 3.11 Windows x86-64

py_ballisticcalc.exts-1.1.0-cp311-cp311-macosx_10_9_universal2.whl (441.8 kB view details)

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

py_ballisticcalc.exts-1.1.0-cp310-cp310-win_amd64.whl (311.7 kB view details)

Uploaded CPython 3.10 Windows x86-64

py_ballisticcalc.exts-1.1.0-cp310-cp310-macosx_11_0_x86_64.whl (328.3 kB view details)

Uploaded CPython 3.10 macOS 11.0+ x86-64

py_ballisticcalc.exts-1.1.0-cp39-cp39-win_amd64.whl (312.5 kB view details)

Uploaded CPython 3.9 Windows x86-64

py_ballisticcalc.exts-1.1.0-cp39-cp39-macosx_11_0_x86_64.whl (329.2 kB view details)

Uploaded CPython 3.9 macOS 11.0+ x86-64

File details

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

File metadata

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

File hashes

Hashes for py_ballisticcalc.exts-1.1.0.tar.gz
Algorithm Hash digest
SHA256 e25a2c2800cb1f85fe383c35444a61005d0002de9621fdf4334bbcc419b4acd2
MD5 1825a86f24c033d1b65f6caafef8767a
BLAKE2b-256 6187c1aa2c08b0347a215520f311bf3c4b4d89d845ee5cc5e38fe318b7547534

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for py_ballisticcalc.exts-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e6c1974e24672ae735d3f8222fb25c6f7d1fc07b90812f72cfb392e83fff94e5
MD5 86bfb7d7d279906ead4162cd7a60dce7
BLAKE2b-256 bd4e64f14fb065e753ce01b1706547b855f42deab09ddc0a460de362a470229d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for py_ballisticcalc.exts-1.1.0-cp312-cp312-win_amd64.whl
Algorithm Hash digest
SHA256 fbdf209c6dee602b9716160a2bb057e1b60be83206aaac46bcf5790db4274d5b
MD5 f9af16870c569a457293d17dad3b36db
BLAKE2b-256 0f53eca17da86d5f7d21344db2c55ba111c2fa4a54a6baa7ef0ea34344b2e7fb

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for py_ballisticcalc.exts-1.1.0-cp312-cp312-macosx_10_9_universal2.whl
Algorithm Hash digest
SHA256 af4bf63c351929f6f2ebdd1d501b1c2f8d0822aae312729fca83c0deb5cdb9d6
MD5 c283f7b7c5f383011e37ea16c023257c
BLAKE2b-256 b3480d9b121d91413dae44617a15fff13b64ce64f255e1435f8915fb8225a566

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for py_ballisticcalc.exts-1.1.0-cp311-cp311-win_amd64.whl
Algorithm Hash digest
SHA256 088eacb1178b34f6c3d6c7e9b920ebad987194c70f28d2d264f16e77c0835e76
MD5 4d22e12d30d5c83836662775337fe646
BLAKE2b-256 961b5af66e5cc00977450f695126d1b69b247a9cafe3c717506d1504ee24ed82

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for py_ballisticcalc.exts-1.1.0-cp311-cp311-macosx_10_9_universal2.whl
Algorithm Hash digest
SHA256 52be7776d9598c6a2134a43aad721831974ca0789c130c4ce84e66da287ddcfe
MD5 70670d2223da2e3b4f382d795f59c78e
BLAKE2b-256 8de4e1f432bf9b62aee5676734e170cc3f4be8c8868a353e81d7d715911c0ece

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for py_ballisticcalc.exts-1.1.0-cp310-cp310-win_amd64.whl
Algorithm Hash digest
SHA256 71b6d4fb5d69dbb6e46de6c904eb005965940732c89e0c39d33b2b8de4bf3503
MD5 3b6700d965265d0e26ebd366adccc86f
BLAKE2b-256 2995aa260a776ef3741e7f779a3b8d473462ed4f357fba90911124c632f62324

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for py_ballisticcalc.exts-1.1.0-cp310-cp310-macosx_11_0_x86_64.whl
Algorithm Hash digest
SHA256 2c0396ce1359bede693d7e95eca11bff986c63f42143923d5ed48c96d29cd17f
MD5 36e5149c72ae7c2d77561cd3b48f159b
BLAKE2b-256 e992a05568bee0b40507dba7cf664990d2e3754f7ff44b77a5e621f95de3db7e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for py_ballisticcalc.exts-1.1.0-cp39-cp39-win_amd64.whl
Algorithm Hash digest
SHA256 df3fde1e1c0b4b94c12b8899739dd636e82fddf7a0acdde9766e158ab3258319
MD5 f82e50126da5b32a1c5bc1637ca29ca7
BLAKE2b-256 faac3627588c1c5317998de168f63469240279be1417120972c743832d428058

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for py_ballisticcalc.exts-1.1.0-cp39-cp39-macosx_11_0_x86_64.whl
Algorithm Hash digest
SHA256 d5823f20e183bb29097cffaa1171a0849592d733148155ba08e4c03ffec3e8df
MD5 3c88cef29628ddeb21791c28724df049
BLAKE2b-256 317ccc6f8ef8a7e5a58c41b02f50bc2435922bfc7fcb9e72f74f75bc71256073

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