Skip to main content

(In Development)

python package

pyords

A library for operations research and data science.

implementation types

  • graph theory
  • genetic algorithm
  • simulation
  • machine learning

motivation behind the project

Self-learning:

  1. Open-source software development
  2. Data Science
  3. Operations Research
  4. Financial Engineering
  5. Visualizations in Python or JavaScript
  6. Big splash! NumPy, Pandas, D3.js, Plotly, Matplotlib, IPython and jupyter, scikit-learn and SciPy, git, Google OR Tools (ortools), Pyomo, Supply Chain Guru, Keras, Hadoop, AWS, GCP, Vagrant

Development & Documentation

pyords Bundles

Bundles are self-contained problem definitions implemented as modular instances. That's wanna-be fancy for packaged units of code that are very plug-in and play. Contributing to Bundle development:

  1. Design the problem as a Case where the Case can be tested against various Bundles that solve the problem defined in the Case. For the purposes of this README we'll use VrpVehicleCase. Cases must help define what is required of a feature implementation (or the improvement of one). For our VrpVehicleCase we'll assume a set of data and configurations for basic vrp model requirements and a desired output of optimized vehicles to append to our data.

  2. Build a Bundle. The bundle should be specific to the Case(s) it solves. Maybe you see where I'm going with this. There are two core components of this library:

    • Bundles
    • Cases
  3. Test the Case against its Bundle.

  4. Submit implementation with documentation supporting the reason for its development.

VrpVehicleCase

  • defines allowable data for one or many vehicles outputs via vrp optimization
  • defines input expectations & tests
  • defines Case expectations & tests
  • defines output expectations & tests
  • related:
    • GeoBundle
    • OrBundle

GeoBundle

  • processed zipcode outputs, lat and lon outputs, haversine distance outputs, and lat and lon cluster outputs
  • integrations:
  • related:
    • ZipcodeCleanCase
    • LatLonCase
    • LatLonDistanceCase
    • LatLonClusterCase

OrBundle

  • operations research optimizations: vrp, network optimization, scheduling.
  • opportunity analysis, health checks.
  • implementations:
    • Vrp optimization via Google OrTools
    • Schedule optimization via Genetic Algorithm
  • integrations:

using pyords Bundles for vehicle optimization

import pyords as pyr


df = pd.read_csv('my_shipment_data.csv')

# TODO: implement this bundle (currently not refactored)
geobndl = pyr.GeoBundle(zipcodes=df.zipcodes)
lats, lons = geo_bndl.pgeo('US')
matrix = geobndl.haversine_all_from(origin=origin, 'mi')
clusters = geobndl.cluster(by='geocodes')

vrpbndl = pyr.VrpBundle(matrix=matrix, demand=df.pallets)
df = vrpbndl.run().cast_solution_to_df(clustered_df)

Testing pyords Bundles ✅

import pyords as pyr

class VrpVehicleCase:
    inputs = {
        'matrix': [[0, 1, 2], [1, 0, 2], [2, 2, 0]],
        'demand': [0, 3, 4],
        'max_vehicle_capacity': 5,
        'partitions': [1, 1, 1],
        'max_search_seconds': 30
    }

    outputs = {
        'vehicle_id': [1, 2]
    }

    implementation = None # TODO: pyr.ortools.vrp

    def run(self):
        bndl = pyr.VrpBundle(case=self)

        assert bndl.test()

        return self

if __name__ == '__main__':
    VrpVehicleCase.run()

Metadata

Release files for pyords 0.0.9

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pyords 0.0.9
File Size Uploaded Provenance Actions
pyords-0.0.9.tar.gz 17.4 kB Without provenance Details for pyords-0.0.9.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for pyords 0.0.9
File Interpreter ABI Platform Actions
pyords-0.0.9-py3-none-any.whl Python 3 none any Details for pyords-0.0.9-py3-none-any.whl

Total release size: 38.0 kB

Release files / pyords-0.0.9.tar.gz

Download URL pyords-0.0.9.tar.gz
Size 17.4 kB
Tags Source
SHA-256 checksum
How to use checksums
3ffb8573289d3f84741d56cc6d52eb7b3d8adadb79cf8801e41e904c3e40a4e1
BLAKE2b-256 checksum
How to use checksums
abdb0b7b9e54148c85fa8a282bb5923df3f7b2649d2a965428b35ea45b690ec5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.8.3

Release files / pyords-0.0.9-py3-none-any.whl

Download URL pyords-0.0.9-py3-none-any.whl
Size 20.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
a6050364a626c21daddcc7afdb50ea7d7c578ae6ae74f5cdbcdd7bdd3bffa0dd
BLAKE2b-256 checksum
How to use checksums
7c59a6048551a1ce8d628e07560bfd4f47ab4b61d093fd3893b173cc90b226ab
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.8.3

Security for pyords 0.0.9

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page