Installing Arakawa

Arakawa's Python library and CLI can be installed using either pip or conda on macOS, Windows, or Linux. Arakawa supports Python 3.9 - 3.12.

Info

Instructions for installing Python can be found at https://wiki.python.org/moin/BeginnersGuide/Download.

Pip¶

If you use pip, you can install it with:

ShellJupyter

pip install -U arakawa

!pip install -U arakawa

Conda¶

Warning

The Conda package is not yet released. The following explanation will be available soon. Please use pip instead for a while.

If you use conda, you can install it with:

ShellJupyter

conda install -c conda-forge arakawa

!conda install -c conda-forge arakawa

Warning

Conda sometimes installs an older version of Arakawa. If you receive errors, please check the version and try running conda update --all or try in a new conda environment (conda create -n ENV and conda activate ENV)

With Extras¶

arakawa comes with Pandas (for data-framing) and Altair (for plotting) by default.

You can install extra dependencies by using plotting, tabling and datafraiming extras.

# install all plotting dependencies
pip install arakawa[plotting]
# install tabling dependencies
pip install arakawa[tabling]
# install dataframing dependencies
pip install arakawa[dataframing]
# install all plotting, tabling and dataframing dependencies
pip install arakawa[all]

Name	Dependencies
`plotting`	Bokeh, Folium, Matplotlib and Plotly
`tabling`	Great Tables
`dataframing`	Polars

Upgrading¶

Upgrading Via Pip¶

If you installed Arakawa via pip, run the following command:

pip install -U arakawa

Upgrading Via Conda¶

Warning

The Conda package is not yet released. The following explanation will be available soon. Please use pip instead for a while.

If you installed arakawa via conda, run the following command, adding the --all flag if needed. As above, if you receive errors please try using a fresh conda environment.

conda update arakawa
# or
conda update --all