Using PyPI

Prerequisite

Python 3.7 or 3.8 (with pip)
Git (for version control integration)
C/C++ compiler (some dependencies may require one during installation, notably XGBoost and python-levenshtein)
- If you are using Windows, make sure "Build Tools for Visual Studio 2019" or newer is installed (check "C++ build tools" during installation).
A modern browser (recent versions of Firefox, Edge or Chrome)

Installation

Type the following command into your terminal and hit enter.
This will install Akimous with all its dependencies. (If it is already installed, it will be upgraded to the latest version)

pip install -U akimous

Starting Application

Start Akimous from the terminal.

akimous

It should automatically open your default browser and show the IDE.

If the browser does not open automatically, check whether the terminal prints something like Starting server, listening on 127.0.0.1:3179. If it does, manually go to the indicated URL (e.g. http://127.0.0.1:3179)

If the default port 3179 is already in use, specify a new one with --port argument. (e.g. akimous --port 12345)

Available command line arguments:

--help: show help message and exit.
--host HOST: specify the host for Akimous server to listen on. (default to 0.0.0.0 if inside docker, otherwise 127.0.0.1)
--port PORT: The port number for Akimous server to listen on. (default=3179)
--no-browser: Do not open the IDE in a browser after startup.
--verbose: Print extra debug messages.

Opening Project Folder

After opening Akimous in the browser, you'll be prompted to open a project folder containing your Python files. Select one and click open.

You can come back here later by using menu item File Open Folder.

Using Docker

If you have difficulty installing, or you are running in a cloud environment, try the prebuilt docker image.

The following command will

Pull the prebuilt Akimous image from Docker Hub.
Mount your home directory to /home/user inside the container.
Bind port 3179 to localhost. (Only access from localhost is allowed for security reason)

docker run --mount type=bind,source=$HOME,target=/home/user \
	-p 127.0.0.1:3179:3179 -it red8012/akimous akimous

If the port is not exposed to the internet and you want access from outside of the machine in a secure intranet, try -p 3179:3179 instead.

Never expose the port to the internet, or every one can run arbitrary code on your computer.