Skip to content

TachyonicProject/photonic

Repository files navigation

Installation

Tachyonic Project photonic currently fully supports CPython 3.6, 3.7.

CPython

A universal wheel is available on PyPI for photonic. Installing it is as simple as:

$ pip3 install photonic

Installing the photonic wheel is a conveniant way to get up and running quickly in a development environment, but for an extra speed boost when deploying your application in production, photonic can compile itself with Cython.

Source Code

Tachyonic Project photonic infrastructure and code is hosted on GitHub. Making the code easy to browse, download, fork, etc. Pull requests are always welcome!

Clone the project like this:

$ git clone https://github.com/TachyonicProject/photonic.git

Once you have cloned the repo or downloaded a tarball from GitHub, you can install Tachyon like this:

$ cd photonic
$ pip3 install .

Or, if you want to edit the code, first fork the main repo, clone the fork to your development area, and then run the following to install it using symbolic linking, so that when you change your code, the changes will be automatically available to your app without having to reinstall the package.

$ cd photonic
$ python3 setup.py develop

You can manually test changes to the photonic by switching to the directory of the cloned repo:

$ python3 setup.py test