Skip to main content

Open-source quantum random coordinate generation for randonauts.

Project description

PyRandonaut

Python PRs Welcome

Open-source quantum random coordinate generation for randonauts ❤️

This is a Python3 module for generating quantum random coordinates. It interfaces with the QRNG, at The Australian National University where it gets a list of quantum random numbers, converts them to coordinates and then computes the gaussian kernel density estimate of those coordinates, similar to how an Attractor point is generated in Randonautica.

This gives you the ability to implement quantum random coordinates in your own applications. Just import pyrandonaut and off you go!

If you're unfamiliar with Randonautica, the concepts of Probability Blind-Spots and Quantum Randomness, I recommend reading fatum_theory.txt which shipped with the original Fatum Project bot that inspired Randonautica. This video gives a lot of great background info too. If you have no idea what any of this is about and is completely new to this, watch this video and/or read this article.

Contributions greatly appreciated!

Table of contents

Installation

The module requires at least Python 3.9 to function and can be installed using pip like so:
pip install pyrandonaut

That's it!

Usage

  • As module

    1. Import the module: import pyrandonaut
    2. You can now call the module functions, e.g.:
     # Define a starting point
     my_latitude = 51.178840902136464
     my_longitude = -1.8261452442305293
     
     # Call get_coordinate() with starting point values and store the result
     result = openrandonaut.get_coordinate(my_latitude, my_longitude)	
     # Print result to screen
     print(f"Go here to escape the stasis field: {result}")
    

    get_coordinate() will return a tuple with the calculated coordinate. By default it uses a radius of 5000 meters and a value of 1024 random points to base the calculation on. These values can be specified in the arguments.

    • Functions and arguments:
      • get_coordinate() is the main functionality of the library, generating a coordinate equivalent to an Attractor point in Randonautica. It takes the following arguments:

        • start_lat Latitude of starting position (float)
        • start_lon Longitude of starting position (float)
        • radius Max radius from starting position (integer)
        • num_points Number of random points to use in calculation of kernel density estimate (integer)

        It returns a tuple in the following format:
        (latitude, longitude)

      • random_location() Converts 2 floating point values to coordinates within the defined radius from the starting position. It takes the following arguments:

        • start_lat Latitude of starting position (float)
        • start_lon Longitude of starting position (float)
        • radius Max radius from starting position (integer)
        • rand_float_1 Random value to turn into X in coordinate
        • rand_float_2 Random value to turn into Y in coordinate

        It returns a tuple in the following format:
        (latitude, longitude)

  • Command-line interface

You can also run PyRandonaut directly in your terminal. Example:

$ python pyrandonaut.py 51.178840902136464 -1.8261452442305293
51.20545110291186, -1.824335160309919

Run the script with --help to see the options:

   $ python pyrandonaut.py --help                                                                                                                             
   usage: pyrandonaut.py [-h] [-r RADIUS] [-p POINTS] [-v] LATITUDE LONGITUDE
   
   This script interfaces with the Quantum Random Number Generator at the The Australian National University, where it gets a list of quantum random numbers, converts them to coordinates and computes the gaussian kernel density estimate of those coordinates, returning the point within the defined radius, where the density of random coordinates is highest, similar to how an Attractor point is calculated by Randonautica.
   
   positional arguments:
     LATITUDE    starting position latitude
     LONGITUDE   starting position longitude
   
   options:
     -h, --help  show this help message and exit
     -r RADIUS   max radius from starting position in meters
     -p POINTS   number of points to base KDE on (must be divisible by 1024)
     -v          verbose logging

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

pyrandonaut-0.1.1.tar.gz (18.0 kB view details)

Uploaded Source

Built Distribution

pyrandonaut-0.1.1-py3-none-any.whl (18.7 kB view details)

Uploaded Python 3

File details

Details for the file pyrandonaut-0.1.1.tar.gz.

File metadata

  • Download URL: pyrandonaut-0.1.1.tar.gz
  • Upload date:
  • Size: 18.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.5

File hashes

Hashes for pyrandonaut-0.1.1.tar.gz
Algorithm Hash digest
SHA256 6b9f56a8d4ff7a4677c4e0ae30bd7c1776d52c8c5dd1635766dec04bd6894fb9
MD5 0f7fdf1d3f4eedb683ae9c67e937c68f
BLAKE2b-256 03504bbff7138c183bb4504a17d767138acec2024b60dc46f75a6cb318ebcca6

See more details on using hashes here.

File details

Details for the file pyrandonaut-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: pyrandonaut-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 18.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.5

File hashes

Hashes for pyrandonaut-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ae1376c8a6d62e8872e6f1b91c269f99aaca2ea035c1994f255827a944f13332
MD5 04685b3e2ff05b97713b3636aad04b01
BLAKE2b-256 ec105e86bd491042a3fc456da8ade6873641a9db9ca0fe291d76e1792cf47a49

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