User Guide#

Welcome to the User Guide for ModularBuildingPy. This guide will walk you through the steps needed to set up and use the tool effectively.

Getting Started#

Prerequisites#

Before proceeding with the installation, make sure you have Python 3.11.5 installed on your system. If you don’t have Python installed, you can download it from the official Python website. Follow the instructions provided on the website to install Python.

This project has been tested with the Intel MPI Library for parallel and distributed computing. The Intel MPI Library is a multi-fabric message passing library that implements the Message Passing Interface (MPI) specification.

To install the Intel MPI Library, follow these steps:

  1. Go to the Intel MPI Library download page.

  2. Click on the “Download” button.

  3. You will be redirected to a page where you can choose your operating system. Select your operating system and click “Next”.

  4. Follow the instructions provided by the installer.

Please note that the Intel MPI Library is part of the Intel oneAPI Base Toolkit, which includes several other development tools. If you don’t need these additional tools, you can choose to install only the Intel MPI Library during the installation process.

While this project has been tested with Intel MPI, it might also work with other MPI implementations like Open MPI. However, compatibility with other MPI implementations is not guaranteed and may require additional configuration.

After installing Python and the Intel MPI Library, you can proceed with the installation of the Python packages required for this project.

The following Python packages and versions are required:

  • numpy==1.25.2

  • pandas==2.1.0

  • matplotlib==3.7.3

  • openseespy==3.5.1.12

  • ipyparallel==8.6.1

  • mpi4py==3.1.5

  • pymetis==2023.1.1

  • scipy==1.11.2

  • shapely==2.0.2

Installation#

Before installing the required packages, it’s recommended to create a new Python virtual environment. This helps to keep the dependencies required by different projects separate and makes it easier to manage packages. Here’s how you can do it:

  1. Install the virtualenv package if it’s not already installed:

pip install virtualenv

  1. Create a new virtual environment. Replace “env_name” with the name you want to give to your virtual environment:

python -m venv env_name

  1. Activate the virtual environment:

On Windows:

.\env_name\Scripts\activate

On macOS and Linux:

source env_name/bin/activate

  1. Once the virtual environment is activated, you can install ModularBuildingPy from PyPI:

pip install modularbuildingpy

or from the file:

pip install modularbuildingpy-0.X.X.tar.gz

Now, you’re ready to use the project in this isolated environment.

Usage#

import modularbuildingpy as mbpy
print(mbpy.__version__)

'0.X.X'

Troubleshooting#

If you encounter any issues, please post them on the ModularBuildingPy GitHub issues page.

FAQ#

This section will be updated with frequently asked questions.

Getting Help#

If you need help with using ModularBuildingPy, please post your questions on the ModularBuildingPy GitHub issues page.

Contributing#

You can contribute to ModularBuildingPy by submitting bug reports, feature requests, or pull requests.

Please fork the repository on GitHub and submit a pull request with your changes. Make sure to include tests for your changes.

Thank you for using ModularBuildingPy!

On this page
Edit on GitHub