_[CEGM1000 MUDE](http://mude.citg.tudelft.nl/), Time Series Analysis, Week 4 of Quarter 2._
_You can access this assignment with the following link: [classroom.github.com/a/lIxPUCXR](https://classroom.github.com/a/lIxPUCXR)._
- This week we will install the software Gurobi, which is required for optimization topic next week. This is to give you enough time to solve any problems with the installation. Next week we will learn how to use it.
This week the programming assignment is based on three files:
-`README.md`: instructions for PA12 and environment creation (this document)
-`PA_2_4_A_gurobilicious.ipynb`: set-up of Gurobi software for Week 2.5 (optimization) with a new conda environment
-`PA_2_4_B_axes_of_awesome.ipynb`: Python-related tools used in Week 2.4 for Time Series Analysis
- a few extra files for the assignment to work properly: `alternation.svg`, `environment.yml`, `gurobitest.py`
**Note:** _the README instructions were updated on Nov 2 to have a better description of the environment creation, below._
## Instructions
Read through this file (`README.md`). This `README.md` also includes a task on creating a new conda environment. Afterwards complete the tasks in notebooks `PA_2_4_A` and `PA_2_4_B`. Note that `PA_2_4_A` will refer you to the MUDE website, where you will find [instructions for setting up the Gurobi license file UPDATE LINK](https://mude.citg.tudelft.nl/software/gurobi/).
...
...
@@ -46,10 +47,11 @@ In summary, as you can see from reading the file, we will set up an environment
The command for creating the environment is simple. Do the following:
1. Open Anaconda Prompt (Windows) / your default terminal app (Mac)
2.Navigate to your working directory (where this file and `environment.yml` is located)
3. Execute this command: `conda env create -f environment.yml`
1. Open the CLI (Terminal) in VS Code
2.Confirm that the CLI prompt is in the same directory as the file `environment.yml`
3. Execute this command: `conda env create -f environment.yml` (if you can't run `conda` commands in the Terminal, you need to add it to your environment path, see [here](https://mude.citg.tudelft.nl/2024/book/external/learn-programming/book/install/common/env_vars_windows.html#setting-the-path-variable))
4. Keep reading this assignment as you wait (this may take several minutes)
5. Remember to use this environment when you want to use Gurobi (e.g., PA 2.4A) by selecting it from the list of kernels in the top-right of a notebook in VS Code.
Do you know why this takes so long? Because we are installing many packages at once! Keep an eye on the terminal window as this process is completed. First `conda` is collecting information about the dependencies, then it will _solve_ the environment; in other words, figure out which version of each package it should use. Once it is ready, it will present the list of packages and proceed with the "installation" (really just downloading `*.py` files and putting them in a folder on your computer) Note that the prompt may ask you to confirm that the installation should proceed, depending on your system settings.
<p><em><ahref="http://mude.citg.tudelft.nl/">CEGM1000 MUDE</a>, Time Series Analysis, Week 4 of Quarter 2.</em></p>
<p><em>You can access this assignment with the following link: <ahref="https://classroom.github.com/a/lIxPUCXR">classroom.github.com/a/lIxPUCXR</a>.</em></p>
<ul>
<li>This week we will install the software Gurobi, which is required for optimization topic next week. This is to give you enough time to solve any problems with the installation. Next week we will learn how to use it.</li>
</ul>
<p>This week the programming assignment is based on three files:</p>
<ul>
<li><code>README.md</code>: instructions for PA12 and environment creation (this document)</li>
<li><code>PA_2_4_A_gurobilicious.ipynb</code>: set-up of Gurobi software for Week 2.5 (optimization) with a new conda environment</li>
<li><code>PA_2_4_B_axes_of_awesome.ipynb</code>: Python-related tools used in Week 2.4 for Time Series Analysis</li>
<li>a few extra files for the assignment to work properly: <code>alternation.svg</code>, <code>environment.yml</code>, <code>gurobitest.py</code></li>
</ul>
<p><strong>Note:</strong><em>the README instructions were updated on Nov 2 to have a better description of the environment creation, below.</em></p>
<h2id="instructions">Instructions</h2>
<p>Read through this file (<code>README.md</code>). This <code>README.md</code> also includes a task on creating a new conda environment. Afterwards complete the tasks in notebooks <code>PA_2_4_A</code> and <code>PA_2_4_B</code>. Note that <code>PA_2_4_A</code> will refer you to the MUDE website, where you will find <ahref="https://mude.citg.tudelft.nl/software/gurobi/">instructions for setting up the Gurobi license file UPDATE LINK</a>.</p>
<h2id="grading-criteria">Grading Criteria</h2>
<p>You will pass this PA if:</p>
<ol>
<li>Your notebook <code>PA_2_4_B_axis_of_awesome.ipynb</code> runs without errors.</li>
<li>A file <code>license.lic</code> is committed to your repository</li>
<li>The license file confirms you have installed the academic license of Gurobi version 12</li>
</ol>
<p>Note that we won't be checking your notebook A for errors, as this will not run on the autograder webserver as it does not have Gurobi installed.</p>
<p>Until now, we have been able to complete our work in MUDE with a few packages like <code>numpy</code> and <code>scipy</code> in our <code>mude</code> environment, which we create and manage with <code>conda</code>. In the previous quarter you also created a new environment, 'mude-week-8'. This week, we will once again create a new environment in preparation for the week on Optimisation ahead. You may have noticed that the environments are always generated using a file called 'environment.yml'. This is just a text-based format (see below) where we can list the packages that we want to be included in our environment. We can then tell <code>conda</code> to create the environment based on the contents of the file!</p>
<p>All we need to do to create an environment from a file is to write a list of what we want and then tell <code>conda</code> to read it. That's it!</p>
<h4id="list-requirements-in-yml-file">List requirements in <code>*.yml</code> file</h4>
<p>To write our list of requirements, we will use a file with a new (to us) file extension: the <code>*.yml</code> file (pronounced "yah-mul"). It is a text-readable file, that stands for "Yet another Markup Language." You don't need to worry about this, except to recognize that this is one of <em>many</em> types of files that use a particular type of text formatting to give a computer specific instructions. It is very similar to the way Markdown formatting works.</p>
<p>Take a look at the contents of the file <code>environment.yml</code> in this repository. Can you understand what is being described? For each section (<code>name</code> and <code>dependencies</code>) you should see that it uses a colon <code>:</code> to list the information. This will be processed by <code>conda</code> when creating the new environment.</p>
<p>There is another special type of formatting with two colons <code>::</code>. This is how we tell <code>conda</code> to look on a specific <em>channel</em> for the particular package. Conda channels are the locations where packages are stored; you can think of them as a specific URL web address. This is where the creator of the package can manage and maintain its distribution (e.g., publishing new versions, installation information, etc). Conda packages are downloaded from these URL's, and if you know where a particular package is stored, you can give <code>conda</code> explicit instructions. For example, we can see that Gurobi is stored on the <code>gurobi</code> channel, because the URL is <code>https://anaconda.org/gurobi/gurobi</code> (note that Anaconda is an organization that provides a wide variety of software; the website anaconda.com is used to provide documentation and information about the organization, whereas anaconda.<strong>org</strong> is explicitly used for package distribution). This is specified in the environment file using the <code>channel::package</code> notation. In the <code>*.yml</code> file, <code>gurobi::gurobi</code> is equivalent to using the command <code>conda install -c gurobi gurobi</code> in Anaconda prompt.</p>
<p>In summary, as you can see from reading the file, we will set up an environment specifically for this assignment, along with a number of dependency packages, two of which are installed from special conda channels.</p>
<h4id="create-environment-from-yml-file">Create environment from <code>*.yml</code> file</h4>
<p>The command for creating the environment is simple. Do the following:</p>
<ol>
<li>Open the CLI (Terminal) in VS Code</li>
<li>Confirm that the CLI prompt is in the same directory as the file <code>environment.yml</code></li>
<li>Execute this command: <code>conda env create -f environment.yml</code> (if you can't run <code>conda</code> commands in the Terminal, you need to add it to your environment path, see <ahref="https://mude.citg.tudelft.nl/2024/book/external/learn-programming/book/install/common/env_vars_windows.html#setting-the-path-variable">here</a>)</li>
<li>Keep reading this assignment as you wait (this may take several minutes)</li>
<li>Remember to use this environment when you want to use Gurobi (e.g., PA 2.4A) by selecting it from the list of kernels in the top-right of a notebook in VS Code.</li>
</ol>
<p>Do you know why this takes so long? Because we are installing many packages at once! Keep an eye on the terminal window as this process is completed. First <code>conda</code> is collecting information about the dependencies, then it will <em>solve</em> the environment; in other words, figure out which version of each package it should use. Once it is ready, it will present the list of packages and proceed with the "installation" (really just downloading <code>*.py</code> files and putting them in a folder on your computer) Note that the prompt may ask you to confirm that the installation should proceed, depending on your system settings.</p>
<p>Once the environment is created, we can activate it, and also check that everything was installed properly. Try <code>conda env export -n ENV_NAME</code> to see what was installed by "default." The list is very long, even though we only asked for a few packages!</p>
<p>It is also interesting to try <code>conda env export --from-history</code> (make sure you activated it already), which shows the specific packages requested. Do you notice anything in particular when looking at the output? That's right, it's exactly the same as our file <code>environment.yml</code>! The only thing extra is that it identifies <code>default</code> as the conda channel (since we didn't specify anything else in the <code>*.yml</code> file).</p>
<h2id="next-steps">Next steps</h2>
<p>Once you have successfully installed our new environment and you have activated it, you are ready to proceed with the rest of this assignment.</p>
<p>We simply presented the instructions for creating an environment in this README; if you would like to read more about this, you should refer to the <ahref="https://conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html#creating-an-environment-from-an-environment-yml-file">Anaconda documentation</a>. You can also read about creating an environment file on the same page <ahref="https://conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html#creating-an-environment-file-manually">here</a>, if interested.</p>
