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
3 changes: 0 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -81,9 +81,6 @@ target/
profile_default/
ipython_config.py

# pyenv
.python-version

# pipenv
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
# However, in case of collaboration, if having platform-specific dependencies or dependencies
Expand Down
1 change: 1 addition & 0 deletions .python-version
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
3.12
49 changes: 27 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,48 +43,53 @@ Pick the installation option that makes sense for you:
### Local Installation
**Warning**: It is highly recommended that you use your personal laptop for the installation.

0. Install the following, if not already installed:
- [Anaconda](https://docs.anaconda.com/anaconda/install/)/[Miniconda](https://docs.conda.io/en/latest/miniconda.html) or [Mamba](https://mamba.readthedocs.io/en/latest/installation/mamba-installation.html)
- [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
1. Install [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git), if not already installed on your computer.

1. Fork this repository:
2. Fork this repository:

![location of fork button in GitHub](./media/fork_button.png)

2. Navigate to your fork, and click the **Code** button:
3. Navigate to your fork, and click the **Code** button:

![location of code button in GitHub](./media/code_button.png)

3. Clone your forked repository using the desired method from the **Local** tab:
4. Clone your forked repository using the desired method from the **Local** tab:

<img width="400px" src="./media/clone_options.png" alt="local cloning options">

4. Create and activate a conda virtual environment (on Windows, these commands should be run in **Anaconda Prompt**):
5. Install one of the following, if not already installed:
- [uv](https://docs.astral.sh/uv/getting-started/installation/) (recommended)
- [Anaconda](https://docs.anaconda.com/anaconda/install/)/[Miniconda](https://docs.conda.io/en/latest/miniconda.html) or [Mamba](https://mamba.readthedocs.io/en/latest/installation/mamba-installation.html). Note that Anaconda/Miniconda is recommended if you are working on a Windows machine and are not very comfortable with the command line.

```shell
$ cd python-data-viz-workshop
~/python-data-viz-workshop$ conda env create --file environment.yml
~/python-data-viz-workshop$ conda activate data_viz_workshop
(data_viz_workshop) ~/python-data-viz-workshop$
```
6. Set up your environment and launch JupyterLab:
- Using `uv`:

*Note: If you installed Mambaforge or have already installed `mamba` in your base environment, you can change `conda env create` to `mamba env create`.*
```shell
$ cd python-data-viz-workshop
$ uv run jupyter lab
```

5. Launch JupyterLab:
- If you installed Anaconda/Miniconda, use `conda` (on Windows, these commands should be run in **Anaconda Prompt**):

```shell
(data_viz_workshop) ~/python-data-viz-workshop$ jupyter lab
```
```shell
$ cd python-data-viz-workshop
$ conda env create --file environment.yml
$ conda activate data_viz_workshop
(data_viz_workshop) $ jupyter lab
```

6. Navigate to the `0-check_your_env.ipynb` notebook in the `notebooks/` folder:
*Note: If you installed Mambaforge or have already installed `mamba` in your base environment, you can change `conda env create` to `mamba env create`.*

7. Navigate to the `0-check_your_env.ipynb` notebook in the `notebooks/` folder:

![open 0-check_your_env.ipynb](./media/open_env_check_notebook.png)

7. Run the notebook to confirm everything is set up properly:
8. Run the notebook to confirm everything is set up properly:

![check env](./media/env_check.png)

### Docker Installation

0. Install the following, if not already installed:
- [Docker](https://docs.docker.com/get-docker/)
- [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
Expand All @@ -105,13 +110,13 @@ Pick the installation option that makes sense for you:

```shell
$ cd python-data-viz-workshop
~/python-data-viz-workshop$ docker compose build
$ docker compose build
```

5. Launch JupyterLab from within a Docker container:

```shell
~/python-data-viz-workshop$ docker compose up
$ docker compose up
```

You should be able to access the environment at <http://localhost:8888>
Expand Down
25 changes: 25 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
[project]
name = "python-data-viz-workshop"
version = "3.0.0"
description = "A workshop on data visualization in Python created by Stefanie Molin"
readme = "README.md"
license-files = [ "LICENSE" ]
authors = [
{ name = "Stefanie Molin", email = "python-data-viz-workshop@stefaniemolin.com" },
]
requires-python = ">=3.9"
dependencies = [
"bokeh==3.4.1",
"ffmpeg",
"geopandas==0.14.4",
"jupyterlab>=4.1.8",
"matplotlib==3.8.4",
"numpy==1.26.4",
"pandas==2.2.2",
"seaborn==0.13.2",
"shapely==2.0.4",
"geoviews==1.12.0",
"holoviews==1.18.3",
"hvplot==0.9.2",
"panel==1.4.2",
]
Loading
Loading