Getting Started#

Supported Platforms#

  • MacOS (Intel CPU)

  • MacOS (ARM CPU)

  • Linux (Raspberry PI)

  • Windows (Intel CPU)

Installation#

  • Make sure you have installed a Python version equal or greater than 3.9, preferably 3.11.

  • Create a virtual environment in the current directory to hold the MIRAGE installation

python -m venv
source bin/activate

  • Create a personal access token on GitHub, described by this article, make sure the token has access to read permissions to your repositories

  • Install the MIRAGE package into your environment with

pip install git+https://${GITHUB_TOKEN}@github.com/ljrobins/mirage.git --upgrade

Where you set GITHUB_TOKEN as an environmental variable equal to the token created earlier. Alternatively, you can just plug the token directly into the pip install like so:

pip install git+https://MY_TOKEN_VALUE@github.com/ljrobins/mirage.git --upgrade

Let me know if you encounter any issues.

License#

This codebase is proprietary to Dr. Carolin Frueh’s Purdue Space Information Dynamics Group with all rights reserved. It comes with the following limitations:

  • Use of the codebase must be limited to academic or personal use

  • Modification of the source code is allowed, but modifications must be marked as such

  • Distribution of the source code in its original form or modifications is forbidden.

  • Academic works published with the help of mirage must cite its contributions

@misc{cvx,
  author       = {Liam Robinson and Carolin Frueh},
  title        = {mirage},
  howpublished = {\url{https://github.com/ljrobins/mirage}},
  month        = jul,
  year         = 2023
}
On this page