Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 5 additions & 20 deletions .github/workflows/conda.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,6 @@ on:
khiops-samples-version:
default: 10.3.2
description: khiops-samples version
release-channel:
type: choice
default: khiops-dev
options: [khiops-dev, khiops]
description: Anaconda channel to release
push:
tags: ['*']
pull_request:
Expand Down Expand Up @@ -205,8 +200,8 @@ jobs:
tests.test_khiops_integrations.KhiopsRunnerEnvironmentTests.test_runner_environment_initialization

# Release is only executed on tags
# Note: For this job to work the secrets variables KHIOPS_ANACONDA_CHANNEL_TOKEN and
# KHIOPS_DEV_ANACONDA_CHANNEL_TOKEN must be set with valid anaconda.org access tokens
# Note: For this job to work the secret variable KHIOPS_DEV_ANACONDA_CHANNEL_TOKEN
# must be set with a valid anaconda.org access token
release:
if: github.ref_type == 'tag'
needs: test
Expand All @@ -232,16 +227,6 @@ jobs:
run: python -m conda_index ./khiops-conda
- name: Upload the Package to anaconda.org
run: |-
# Set the anaconda.org channel
ANACONDA_CHANNEL="${{ inputs.release-channel || 'khiops-dev' }}"

# For the release channel: upload without forcing
if [[ "$ANACONDA_CHANNEL" == "khiops" ]]
then
anaconda --token "${{ secrets.KHIOPS_ANACONDA_CHANNEL_TOKEN }}" upload \
--user "$ANACONDA_CHANNEL" ./khiops-conda/noarch/*.conda
# For the dev channel: upload with forcing
else
anaconda --token "${{ secrets.KHIOPS_DEV_ANACONDA_CHANNEL_TOKEN }}" upload \
--user "$ANACONDA_CHANNEL" --force ./khiops-conda/noarch/*.conda
fi
# Override versions, as the packages are pushed to a dev channel
anaconda --token "${{ secrets.KHIOPS_DEV_ANACONDA_CHANNEL_TOKEN }}" upload \
--user khiops-dev --force ./khiops-conda/noarch/*.conda
22 changes: 20 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,28 @@ in two ways:

## Installation

Using `conda`
```bash
conda install -c conda-forge -c khiops khiops
conda create -n khiops-env
conda activate khiops-env
conda install -c conda-forge khiops
```
Other install methods are documented at the [Khiops website][khiops-install].

Using `pip` under Linux (in a `bash` shell)
```bash
python -m venv khiops-venv
source khiops-venv/bin/activate
pip install -U khiops
```

Using `pip` under Windows (in a `powershell` shell)
```shell
python -m venv khiops-venv
khiops-venv\Scripts\activate
pip install -U khiops
```

Other installation methods are documented at the [Khiops website][khiops-install].

### Requirements
- [Python][python] (>=3.8)
Expand Down
25 changes: 22 additions & 3 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,30 @@ Welcome to the Khiops Python API documentation page.

Installation
------------
Khiops is better installed with `conda package manager <https://docs.conda.io/en/latest/>`_
Khiops can be installed with `conda package manager <https://docs.conda.io/en/latest/>`_

.. code-block:: shell
.. code-block:: bash

conda install -c conda-forge -c khiops khiops
conda create -n khiops-env
conda activate khiops-env
conda install -c conda-forge khiops

Alternatively, you can install in a virtual environment using `pip`,
under Linux (in a `bash` shell) :

.. code-block:: bash

python -m venv khiops-venv
source khiops-venv/bin/activate
pip install -U khiops

under Windows (in a `powershell` shell) :

.. code-block:: powershell

python -m venv khiops-venv
khiops-venv\Scripts\activate
pip install -U khiops

More details and other install methods are documented at the `Khiops website
<https://www.khiops.org/setup>`_.
Expand Down