Rename environment.yml to conda-environment.yml

Author: JohT

.github/workflows/public-analyze-code-graph.yml

@@ -109,7 +109,7 @@ jobs:
           python-version: ${{ matrix.python }}
           miniforge-version: ${{ matrix.miniforge }}
           activate-environment: codegraph
-          environment-file: ./environment.yml
+          environment-file: ./conda-environment.yml
           auto-activate-base: false
           show-channel-urls: true
       - name: (Python Setup) Conda environment info

COMMANDS.md

@@ -389,23 +389,23 @@ Here is an example on how to use [executeJupyterNotebook.sh](./scripts/executeJu
   conda activate codegraph
   ```
 
-  or by using the codegraph environment file [environment.yml](./environment.yml):
+  or by using the codegraph environment file [conda-environment.yml](./conda-environment.yml):
 
   ```shell
-  conda env create --file ./environment.yml
+  conda env create --file ./conda-environment.yml
   conda activate codegraph
   ```
 
-- Export full environment.yml
+- Export full conda-environment.yml
 
   ```shell
-  conda env export --name codegraph > full-codegraph-environment.yml
+  conda env export --name codegraph > full-codegraph-conda-environment.yml
   ```
 
-- Export only explicit environment.yml
+- Export only explicit conda-environment.yml
 
   ```shell
-  conda env export --from-history --name codegraph | grep -v "^prefix: " > explicit-codegraph-environment.yml
+  conda env export --from-history --name codegraph | grep -v "^prefix: " > explicit-codegraph-conda-environment.yml
   ```
 
 ### Executing Jupyter Notebooks with nbconvert

README.md

@@ -137,7 +137,7 @@ The [Code Structure Analysis Pipeline](./.github/workflows/internal-java-code-an
 - Start [Neo4j](https://neo4j.com) Graph Database ([analysis.sh](./scripts/analysis/analyze.sh))
 - Generate CSV Reports [scripts/reports](./scripts/reports) using the command line JSON parser [jq](https://jqlang.github.io/jq)
 - Uses [Neo4j Graph Data Science](https://neo4j.com/product/graph-data-science) for community detection, centrality, similarity, node embeddings and topological sort ([analysis.sh](./scripts/analysis/analyze.sh))
-- Generate [Jupyter Notebook](https://jupyter.org) reports using these libraries specified in the [environment.yml](./environment.yml):
+- Generate [Jupyter Notebook](https://jupyter.org) reports using these libraries specified in the [conda-environment.yml](./conda-environment.yml):
   - [Python](https://www.python.org)
   - [jupyter](https://jupyter.org)
   - [matplotlib](https://matplotlib.org)

environment.yml renamed to conda-environment.yml

@@ -3,7 +3,7 @@
 # Activates the Conda (Python package manager) environment "codegraph" with all packages needed to execute the Jupyter Notebooks.
 
 # Note: This script uses the conda environment defined in CODEGRAPH_CONDA_ENVIRONMENT (defaults to "codegraph").
-#       If the environment hadn't been created yet, it will use "environment.yml" from the root directory
+#       If the environment hadn't been created yet, it will use "conda-environment.yml" from the root directory
 #       in the same directory as the given jupyter notebook ipynb file
 #       to create the environment.
 
@@ -25,7 +25,7 @@ echo "activateCondaEnvironment: JUPYTER_NOTEBOOK_DIRECTORY=${JUPYTER_NOTEBOOK_DI
 
 # Get the file name of the environment description file for the conda package and environment manager 
 # that contains all dependencies and their versions.
-CONDA_ENVIRONMENT_FILE=${CONDA_ENVIRONMENT_FILE:-"${JUPYTER_NOTEBOOK_DIRECTORY}/../environment.yml"} # Conda (package manager for Python) environment file path
+CONDA_ENVIRONMENT_FILE=${CONDA_ENVIRONMENT_FILE:-"${JUPYTER_NOTEBOOK_DIRECTORY}/../conda-environment.yml"} # Conda (package manager for Python) environment file path
 if [ ! -f "${CONDA_ENVIRONMENT_FILE}" ] ; then
     echo "activateCondaEnvironment: Couldn't find environment file ${CONDA_ENVIRONMENT_FILE}."
     exit 2

scripts/activateCondaEnvironment.sh

@@ -11,7 +11,7 @@
 #       The original ones are typically saved with all outputs cleared to be able to better compare their changes with git diff.
 
 # Note: This script uses the conda environment defined in CODEGRAPH_CONDA_ENVIRONMENT (defaults to "codegraph").
-#       If the environment hadn't been created yet it will use "environment.yml" 
+#       If the environment hadn't been created yet it will use "conda-environment.yml" 
 #       in the same directory as the given jupyter notebook ipynb file
 #       to create the environment.