diff --git a/.github/workflows/conda.yml b/.github/workflows/conda.yml index 11fdc7d4..47f805dd 100644 --- a/.github/workflows/conda.yml +++ b/.github/workflows/conda.yml @@ -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: @@ -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 @@ -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 diff --git a/README.md b/README.md index dc84ad0d..d3672749 100644 --- a/README.md +++ b/README.md @@ -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) diff --git a/doc/index.rst b/doc/index.rst index 40f769a4..206dca35 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -6,11 +6,30 @@ Welcome to the Khiops Python API documentation page. Installation ------------ -Khiops is better installed with `conda package manager `_ +Khiops can be installed with `conda package manager `_ -.. 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 `_.