orbx 1.0.0__tar.gz

orbx-1.0.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

orbx-1.0.0/PKG-INFO

@@ -0,0 +1,233 @@
+Metadata-Version: 2.4
+Name: orbx
+Version: 1.0.0
+Summary: Satellite orbit similarity clustering, density estimation, and synthetic orbit generation.
+Author-email: Sam White <sam.m.whit3@gmail.com>
+License-Expression: Apache-2.0
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pandas
+Requires-Dist: numpy
+Requires-Dist: hdbscan
+Requires-Dist: sgp4
+Requires-Dist: tqdm
+Requires-Dist: matplotlib
+Requires-Dist: plotly
+Requires-Dist: scikit-learn
+Requires-Dist: s-dbw
+Requires-Dist: viasckde
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == "dev"
+Requires-Dist: pytest-cov>=5.0; extra == "dev"
+Dynamic: license-file
+
+# OrbX
+
+OrbX is a Python toolkit for orbital capacity analysis. It clusters orbits based on geometrical similarity using Keplerian elements (excluding mean motion), generates representative synthetic orbits for each cluster, and computes a density score that helps quantify how tightly packed different orbital neighbourhoods are.
+
+This project was developed as part of the following paper:
+
+> **OrbX: A Framework for Orbital Capacity Management**  
+> Sam White, Samya Bagchi, Yasir Latif  
+> 12th Annual Space Traffic Management Conference, Austin TX, February 2026  
+> [Paper link](https://github.com/importsam/OrbX/blob/main/OrbX__A_Framework_for_Orbital_Capacity_Characterization.pdf)
+
+OrbX is designed for workflows such as:
+
+- grouping similar resident space objects into orbital neighbourhoods/clusters
+- identifying representative reference orbits for a cluster
+- finding the most geometrically isolated orbit within a neighbourhood
+- comparing cluster density
+
+---
+
+## Installation
+
+```bash
+pip install orbx
+```
+
+**Requirements:**
+
+- Python `3.9+`
+
+> **Note:** [orekit](https://gitlab.orekit.org/orekit-labs/python-wrapper) is required for `density()` and `synthetic_orbit()`. Orekit is not pip installable, so install it via Conda if needed:
+>
+> ```bash
+> conda install -c conda-forge orekit
+> ```
+
+---
+
+## Quick Start
+
+```python
+import pandas as pd
+from orbx import cluster, synthetic_orbit, density
+
+df = pd.DataFrame(
+    {
+        "line1": [...],
+        "line2": [...],
+    }
+)
+
+# 1. Cluster orbits
+labels = cluster(df)
+df["label"] = labels
+
+# 2. Remove noise (recommended, optional)
+clustered_df = df[df["label"] != -1].copy()
+
+# 3. Generate synthetic orbits
+synthetic_df = synthetic_orbit(
+    clustered_df,
+    mode=["frechet", "max_separation"]
+)
+
+# 4. Score cluster density
+density_df = density(clustered_df)
+```
+
+---
+
+## What OrbX Does
+
+OrbX exposes three core functions:
+
+### `cluster()`
+
+Clusters satellite orbits based on geometric similarity, using [HDBSCAN](https://scikit-learn.org/stable/modules/generated/sklearn.cluster.HDBSCAN.html) and Keplerian elements extracted from [two-line elements](https://en.wikipedia.org/wiki/Two-line_element_set) (TLEs).
+
+### `synthetic_orbit()`
+
+Generates one or more synthetic orbits for each non-noise cluster. Two modes are supported:
+
+- `"frechet"` — computes a Fréchet mean orbit, which acts like a centroid in a non-Euclidean orbital metric space
+- `"max_separation"` — finds an orbit inside the cluster region that maximises separation from existing members, highlighting available space within the neighbourhood
+
+### `density()`
+
+Computes a density score for each labelled cluster by measuring dispersion around the cluster's Fréchet mean orbit. Useful for ranking or comparing how concentrated orbital neighbourhoods are within.
+
+---
+
+## Input Format
+
+A minimum OrbX workflow may start with a DataFrame containing TLE rows:
+
+```python
+import pandas as pd
+
+df = pd.DataFrame(
+    {
+        "line1": [...],
+        "line2": [...],
+    }
+)
+```
+
+After clustering, add the returned labels back onto the DataFrame in a `label` column before calling `synthetic_orbit()` or `density()`.
+
+---
+
+## API Reference
+
+### `cluster(df, min_samples=3, min_cluster_size=2, verbose=False)`
+
+Groups similar TLEs into orbital neighbourhoods and returns one cluster label per input row.
+
+**Arguments:**
+
+
+| Argument           | Type        | Description                                                                                                                    |
+| ------------------ | ----------- | ------------------------------------------------------------------------------------------------------------------------------ |
+| `df`               | `DataFrame` | Must contain `line1` and `line2` TLE columns. Each row is one object.                                                          |
+| `min_samples`      | `int`       | Controls clustering conservativeness. Higher values require stronger local support, which can increase noise points (`-1`).    |
+| `min_cluster_size` | `int`       | Minimum cluster size HDBSCAN will return. Higher values suppress small clusters and favour larger, more stable neighbourhoods. |
+| `verbose`          | `bool`      | If `True`, shows internal clustering output and warnings.                                                                      |
+
+
+**Tuning notes:**
+
+- Lower `min_samples` and `min_cluster_size` → more, smaller clusters
+- Higher `min_samples` and `min_cluster_size` → fewer clusters, more noise points
+- Both parameters default to the values used in the paper
+
+**Returns:** NumPy array of integer cluster labels aligned to input row order. `-1` = noise / unclustered.
+
+---
+
+### `synthetic_orbit(df, mode="max_separation", n_samples=5000, verbose=False)`
+
+Generates synthetic orbits for each cluster in a labelled DataFrame. Two modes are supported:
+
+- `"frechet"` — computes a Fréchet mean orbit, which represents a centroid in a non-Euclidean orbital metric space
+- `"max_separation"` — finds an orbit inside the cluster that maximises separation from existing cluster members
+
+**Arguments:**
+
+
+| Argument    | Type            | Description                                                                                                   |
+| ----------- | --------------- | ------------------------------------------------------------------------------------------------------------- |
+| `df`        | `DataFrame`     | Must contain `line1`, `line2`, and `label` columns.                                                           |
+| `mode`      | `str` or `list` | `"frechet"`, `"max_separation"`, or `["frechet", "max_separation"]` to run both.                              |
+| `n_samples` | `int`           | Initial candidate samples for `"max_separation"` search. Higher values improve quality, but increase runtime. |
+| `verbose`   | `bool`          | If `True`, shows optimiser warnings and progress.                                                             |
+
+
+**Returns:** DataFrame of synthetic TLE rows with columns `line1`, `line2`, `label`, and `synthetic_type`.
+
+---
+
+### `density(df, label_column="label", verbose=False)`
+
+Computes a density score for each cluster by measuring the spread of member orbits around the cluster's Fréchet mean orbit.
+
+**Arguments:**
+
+
+| Argument       | Type        | Description                                                              |
+| -------------- | ----------- | ------------------------------------------------------------------------ |
+| `df`           | `DataFrame` | Must contain `line1`, `line2`, and a cluster label column.               |
+| `label_column` | `str`       | Name of the column containing cluster IDs. Defaults to `"label"`.        |
+| `verbose`      | `bool`      | If `True`, shows optimiser diagnostics while computing the Fréchet mean. |
+
+
+**Returns:** DataFrame with one row per cluster and columns `label` and `density`. Values should be interpreted relative to other clusters in the same analysis — lower density means a more dispersed neighbourhood, higher means more tightly packed.
+
+---
+
+## Outputs
+
+
+| Function            | Returns                                                    |
+| ------------------- | ---------------------------------------------------------- |
+| `cluster()`         | NumPy array of integer cluster labels                      |
+| `synthetic_orbit()` | DataFrame with `line1`, `line2`, `label`, `synthetic_type` |
+| `density()`         | DataFrame with `label` and `density` per cluster           |
+
+
+---
+
+## Demo
+
+
+| Demo                                                                 | Description                                                                     |
+| -------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
+| [Unique Orbits (k-NN) Cesium Model](https://orbx.spaceprotocol.org/) | 3D Cesium visualisation of orbital neighbourhoods and uniqueness across regimes |
+
+
+---
+
+## References
+
+
+| Ref | Resource                   | Link                                                                                                                                                             |
+| --- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [1] | scikit-learn `HDBSCAN` API | [https://scikit-learn.org/stable/modules/generated/sklearn.cluster.HDBSCAN.html](https://scikit-learn.org/stable/modules/generated/sklearn.cluster.HDBSCAN.html) |
+| [2] | OrbX conference paper      | [https://utexas.app.box.com/v/26space-traffic-conference/file/2126683483061](https://github.com/importsam/OrbX/blob/main/OrbX__A_Framework_for_Orbital_Capacity_Characterization.pdf)         |
+| [3] | Two-line element set (TLE) | [https://en.wikipedia.org/wiki/Two-line_element_set](https://en.wikipedia.org/wiki/Two-line_element_set)                                                         |
+
+

orbx-1.0.0/pyproject.toml

@@ -0,0 +1,47 @@
+[build-system]
+requires = ["setuptools>=68", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "orbx"
+version = "1.0.0"
+description = "Satellite orbit similarity clustering, density estimation, and synthetic orbit generation."
+requires-python = ">=3.9"
+readme = "readme.md"
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+authors = [{ name = "Sam White", email = "sam.m.whit3@gmail.com" }]
+dependencies = [
+    "pandas",
+    "numpy",
+    "hdbscan",
+    "sgp4",
+    "tqdm",
+    "matplotlib",
+    "plotly",
+    "scikit-learn",
+    "s-dbw",
+    "viasckde"
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=8.0",
+    "pytest-cov>=5.0",
+]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+pythonpath = ["src", "."]
+addopts = "-ra"
+markers = [
+    "integration: tests that need orekit or heavy orbit computations",
+    "slow: end-to-end clustering or density runs",
+]
+
+[tool.setuptools.packages.find]
+where = ["src"]   
+
+[tool.setuptools.package-data]
+"orbx" = ["py.typed"] 
+