Skip to content

Commit

Permalink
update instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
Gorkowski committed Jun 3, 2024
1 parent 49d9ee1 commit 523407d
Showing 1 changed file with 52 additions and 3 deletions.
55 changes: 52 additions & 3 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,65 @@
# Home

The documentation for `particula` is organized into Jupyter notebooks that can be executed in the browser.
The documentation for `particula` is organized into source code and examples in Jupyter notebooks.
To learn more about Jupyter notebooks, visit [jupyter.org](https://jupyter.org/) and [jupyterbook.org](https://jupyterbook.org/).

## Gorkowski/PARTICULA

This repository is a development fork of `Particula`. Since this is an active development environment, the codebase may undergo frequent changes, and instability can occur. To install this version directly, use the following `pip` command:
## Getting Started with Python

If you are new to Python, it's highly recommended to go through an introductory course to build a solid foundation. "Python for Everybody" is an excellent free resource that covers the basics and beyond:
- Access the course and materials at [Python for Everybody](https://www.py4e.com/).

With these steps, you have set up your development environment, installed the project, and know where to start learning Python. You’re now ready to start coding in VSCode. Remember to activate your `analysisV1` environment whenever you resume work on this project to maintain a consistent and isolated workspace.


## Gorkowski/PARTICULA Setup Instructions

Welcome to the development fork of `Particula`. This repository is actively developed, so you may encounter frequent updates and some instability as new features are integrated.

### Setting Up Your Development Environment

**Step 1: Install Visual Studio Code (VSCode)**

To edit and manage your code efficiently, download and install Visual Studio Code, a popular code editor that supports Python and many other languages.
- Visit the [Visual Studio Code website](https://code.visualstudio.com/) to download the installer for Windows.
- Follow the installation prompts to install VSCode on your machine.
- Once installed, launch VSCode to configure it for Python development.

**Step 2: Install Miniconda**

Install Miniconda, which includes Conda, a powerful package and environment manager. This tool will help you manage different project dependencies separately and efficiently.
- Download Miniconda for Windows from [Miniconda's website](https://docs.conda.io/en/latest/miniconda.html).
- Follow the installation instructions to install Miniconda on your system.

**Step 3: Create a New Python Environment**

Avoid conflicts with other development projects by creating an isolated Python environment. Here’s how:
- Open VSCode, then open the integrated terminal (`Terminal > New Terminal`).
- Use the following Conda command to create an environment named `analysisV1` with Python 3.11:

```bash
conda create --name analysisV1 python=3.11
```

**Step 4: Activate the Environment**

Ensure you’re working within the context of your new environment:
- In the VSCode terminal, activate your environment by running:

```bash
conda activate analysisV1
```

### Installing the Project

**Step 5: Install the Project**

Now, install the `Particula` fork directly using pip in your activated environment:
```bash
pip install git+https://github.com/Gorkowski/particula.git
```


<!-- ## Installing `particula`
You can install `particula` from PyPI using the following command:
Expand Down

0 comments on commit 523407d

Please sign in to comment.