Skip to content

Commit

Permalink
Update ReadMe (#42)
Browse files Browse the repository at this point in the history
* update installation to use setup_scripts and update dependencies+ structure

* adjust readme for manualy approach

* try to fix 3 and 3.2 in 1 line

* fix typo
  • Loading branch information
Toddelismyname authored Dec 13, 2024
1 parent 4cc73b3 commit eaa1dd1
Showing 1 changed file with 63 additions and 16 deletions.
79 changes: 63 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,16 +26,28 @@ git clone https://github.com/your-organization/precice-structure-generator.git
cd precice-structure-generator
```

2. Create and activate a virtual environment (recommended):
2. Execute the setup script for your system inside the setup_scripts directory:
```bash
python -m venv venv
source venv/bin/activate # On Windows, use `venv\Scripts\activate`
./setup_scripts/install_dependencies.sh
#or
./setup_scripts/install_dependencies.ps1
```

3. Install dependencies:
```bash
pip install -r requirements.txt
```
3. Alternatively, if you like to do it manually:

3.1 Create and activate a virtual environment (recommended):
```bash
python -m venv venv
source venv/bin/activate # On Windows, use `venv\Scripts\activate`
```
3.2 Install dependencies:
```bash
pip install -r requirements.txt
```
3.3 Initialize the submodule:
```bash
git submodule update --init
```

## Usage

Expand All @@ -55,25 +67,60 @@ python FileGenerator.py -f path/to/your/topology.yaml

## Dependencies

- attrs==24.2.0
- colorama==0.4.6
- exceptiongroup==1.2.2
- iniconfig==2.0.0
- jsonschema==4.23.0
- jsonschema-specifications==2024.10.1
- lxml==5.3.0
- myutils==0.0.21
- packaging==24.2
- pip-check-reqs==2.5.3
- pluggy==1.5.0
- pyaml==24.9.0
- pytest==8.3.4
- PyYAML==6.0.2
- referencing==0.35.1
- rpds-py==0.22.1
- termcolor==2.5.0
- tomli==2.2.1
- xmltodict==0.14.2


## Project Structure

```
precice-structure-generator/
├── FileGenerator.py # Main script for configuration generation
├── requirements.txt # Project dependencies
├── _generated/ # Output directory for generated files
├── controller/ # Controller modules
│ ├── ui_struct/ # User interface handling
│ ├── myutils/ # Utility modules
│ └── precice_struct/ # preCICE configuration modules
├── generation_utils/ # Utility modules for file generation
└── README.md # Project documentation
├── .github/ # GitHub-specific configurations
├── .git/ # Git version control directory
├── controller_utils/ # Utility from controller
│ ├── examples/
│ ├── myutils/ # Miscellaneous utilities
│ ├── precice_struct/ # preCICE configuration structures
│ └── ui_struct/ # User interface utilities
├── generation_utils/ # Core generation utilities
│ ├── AdapterConfigGenerator.py
│ ├── Logger.py
│ └── StructureHandler.py
├── schemas/ # JSON/validation schemas
├── setup_scripts/ # Setup and initialization scripts
├── templates/ # Configuration templates
├── tests/ # Project test suite
├── tutorials/ # Extensive tutorials (1135 items!) (from original preCICE)
├── validation/ # Validation modules
├── _generated/ # Generated configuration files
├── FileGenerator.py # Main file generation script
├── README.md # Project documentation (This file)
├── requirements.txt # Project dependencies
├── pyproject.toml # Project configuration
└── .gitignore # Git ignore file
```
## Logging and Error Handling
Expand Down

0 comments on commit eaa1dd1

Please sign in to comment.