Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated README doc #221

Closed
wants to merge 3 commits into from
Closed
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
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
</p>

[![Installation Options](https://img.shields.io/badge/Install%20with-conda%20%7C%20pip-brightgreen)](#installing-the-open-ce-build-tools)
[![Python Support](https://img.shields.io/badge/python-3.8%20%7C%203.9%20%7C3.10-blue.svg)](#requirements)
[![Cuda Support](https://img.shields.io/badge/cuda-11.2%20%7C%2011.8%20-blue)](doc/README.cuda_support.md)
[![Python Support](https://img.shields.io/badge/python-3.10%20%7C%203.11-blue.svg)](#requirements)
[![Cuda Support](https://img.shields.io/badge/cuda-11.8%20%7C%2012.2-blue)](doc/README.cuda_support.md)

[![Builder Unit Tests](https://github.com/open-ce/open-ce/workflows/Open-CE%20Builder%20Unit%20Tests/badge.svg)](https://github.com/open-ce/open-ce-builder/actions?query=workflow%3A%22Open-CE+Builder+Unit+Tests%22+branch%3Amain)
[![Builder Unit Test Coverage](https://codecov.io/gh/open-ce/open-ce-builder/branch/main/graph/badge.svg)](https://codecov.io/gh/open-ce/open-ce-builder)
Expand Down Expand Up @@ -77,6 +77,7 @@ pip install -e .
| 1.8.1 | 12.0.2 |
| 1.9.4 | 12.0.3 |
| 1.10.0 | 13.0.0 |
| 1.11.0 | 13.0.0 |

### Building a Collection of Packages
To build an entire integrated and functional conda channel using Open-CE, start by installing the needed tools in the [Requirements](#requirements) section above.
Expand All @@ -102,18 +103,18 @@ open-ce build env opence-env

A specific version of an environment file from the open-ce repo can be built using the `--git_tag` flag.

The following commands will build version 1.1.4 of the open-ce environment file provided within the open-ce [repo](https://github.com/open-ce/open-ce):
The following commands will build version 1.11.0 of the open-ce environment file provided within the open-ce [repo](https://github.com/open-ce/open-ce):

```bash
# Build packages
open-ce build env --git_tag open-ce-v1.1.4 opence-env
open-ce build env --git_tag open-ce-v1.11.0 opence-env
```

The following commands will use the `opence-env.yaml` Open-CE environment file from a specific Open-CE release to build all of the Open-CE packages for Python 3.9, 3.10 and 3.11, including only CUDA builds. The commands should be run from within the same directory that contains `local_files`.
The following commands will use the `opence-env.yaml` Open-CE environment file from a specific Open-CE release to build all of the Open-CE packages for Python 3.10 and 3.11, including only CUDA builds. The commands should be run from within the same directory that contains `local_files`.

```bash
# Build packages
open-ce build env --python_versions 3.9,3.10,3.11 --build_types cuda opence-env
open-ce build env --python_versions 3.10,3.11 --build_types cuda opence-env
```

Note that having _conda-forge_ in your channel list may sometime cause conflicts or unexpected errors due to dependencies' versions mismatch. So, it is recommended to avoid mixing the channels during the build as well as at runtime.
Expand Down
2 changes: 2 additions & 0 deletions open_ce/images/builder-cuda/Dockerfile.cuda-12.2
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ ENV CUDA_HOME=/usr/local/cuda

ENV OPEN_CE_CONDA_BUILD=3.22.0
ENV OPEN_CE_CONDA=4.14
ENV OPENSSL_VER=3.*

ENV CICD_GROUP=cicd
ARG GROUP_ID=1500
Expand Down Expand Up @@ -36,6 +37,7 @@ RUN export ARCH="$(uname -m)" && \
$CONDA_HOME/bin/conda config --system --set auto_update_conda false && \
$CONDA_HOME/bin/conda config --system --set notify_outdated_conda false && \
$CONDA_HOME/bin/conda --version && \
$CONDA_HOME/bin/conda install openssl=3 && \
mkdir -p $CONDA_HOME/conda-bld && \
mkdir -p $HOME/.cache && \
echo "export PYTHONPATH=${PYTHONPATH}:$HOME/open_ce" >> ${HOME}/.bashrc && \
Expand Down
2 changes: 2 additions & 0 deletions open_ce/images/builder/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ ENV PATH=$CONDA_HOME/bin:$PATH

ENV OPEN_CE_CONDA_BUILD=3.22.0
ENV OPEN_CE_CONDA=4.14
ENV OPENSSL_VER=3.*

ENV CICD_GROUP=cicd
ARG GROUP_ID=1500
Expand Down Expand Up @@ -32,6 +33,7 @@ RUN export ARCH="$(uname -m)" && \
$CONDA_HOME/bin/conda config --system --set auto_update_conda false && \
$CONDA_HOME/bin/conda config --system --set notify_outdated_conda false && \
$CONDA_HOME/bin/conda --version && \
$CONDA_HOME/bin/conda install openssl=3 && \
mkdir -p $CONDA_HOME/conda-bld && \
mkdir -p $HOME/.cache && \
echo "export PYTHONPATH=${PYTHONPATH}:$HOME/open_ce" >> ${HOME}/.bashrc && \
Expand Down
2 changes: 2 additions & 0 deletions open_ce/images/builder/Dockerfile-p10
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ ENV PATH=$CONDA_HOME/bin:$PATH

ENV OPEN_CE_CONDA_BUILD=3.22.0
ENV OPEN_CE_CONDA=4.14
ENV OPENSSL_VER=3.*

ENV CICD_GROUP=cicd
ARG GROUP_ID=1500
Expand Down Expand Up @@ -35,6 +36,7 @@ RUN export ARCH="$(uname -m)" && \
$CONDA_HOME/bin/conda config --system --set notify_outdated_conda false && \
$CONDA_HOME/bin/conda config --system --add create_default_packages openssl=${OPENSSL_VER} && \
$CONDA_HOME/bin/conda --version && \
$CONDA_HOME/bin/conda install openssl=3 && \
mkdir -p $CONDA_HOME/conda-bld && \
mkdir -p $HOME/.cache && \
echo "export PYTHONPATH=${PYTHONPATH}:$HOME/open_ce" >> ${HOME}/.bashrc && \
Expand Down
1 change: 1 addition & 0 deletions open_ce/images/builder/Dockerfile-s390x
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ RUN export ARCH="$(uname -m)" && \
$CONDA_HOME/bin/conda config --system --set notify_outdated_conda false && \
$CONDA_HOME/bin/conda config --system --add create_default_packages openssl=${OPENSSL_VER} && \
$CONDA_HOME/bin/conda --version && \
$CONDA_HOME/bin/conda install openssl=3 && \
mkdir -p $CONDA_HOME/conda-bld && \
mkdir -p $HOME/.cache && \
echo "export PYTHONPATH=${PYTHONPATH}:$HOME/open_ce" >> ${HOME}/.bashrc && \
Expand Down
Loading