Skip to main content

Type hints for Abaqus/Python scripting

Project description

abqpy 2021

Documentation Status Documentation Status Tests CodeQL

Read this in other languages: English, 简体中文.

Type hints for Abaqus/Python scripting

abqpy is a Python package providing type hints for Python scripting of Abaqus, you can use it to write your Python script of Abaqus fluently, even without doing anything in Abaqus. It also provides some simple APIs to execute the Abaqus commands so that you can run your Python script to build the model, submit the job and extract the output data in just one Python script, even without opening the Abaqus/CAE.

Other links for this project

Pull Requests are Welcome

Since abqpy is reconstructed from the official Abaqus documentation, many of the docstrings are not well formatted, for example, the Raises section, the math equations, the attributes of the objects, due to the limitation of my time, those things are left behind, if anyone is willing to make any contributions, please feel free to create your pull requests.

Installation

abqpy supports Python 3.7 or a later version. If you are using Python 3.6 or an earlier version, please upgrade to Python 3.7 or a later version.

abqpy is uploaded to PyPI, you can simply install it using pip:

pip install abqpy

abqpy is also uploaded to anaconda, you can use conda to install it:

conda install -c haiiliin abqpy

You may install the latest development version by cloning the GitHub repository and use python to install from the local directory:

git clone https://github.com/haiiliin/abqpy.git
cd abqpy
pip install -r requirements.txt
python setup.py install

Install A Specific Version

You can specify the version number when installing abqpy, for example:

Using pip:

pip install abqpy==2021.3.5

Using conda:

conda install -c haiiliin abqpy=2021.3.5

A better way is to use * to match specific version:

pip install abqpy==2021.*

Optional Requirements

You can put your Abaqus/Python script into a Jupyter Notebook. When you run the notebook, the package will convert the notebook into a plain Python file with the same name but with .py suffix instead of .ipynb, and then it will be submitted to Abaqus kernel.

Go examples for tests using Jupyter Notebooks to build the Abaqus model.

In order to use the Jupyter Notebook feature, you have to install ipynbname:

pip install ipynbname

Setup Abaqus Environment

In order to use Abaqus command to execute the Python script and submit the job, you need to tell abqpy where the Abaqus command is located. Usually, Abaqus command locates in a directory like this:

C:/SIMULIA/Commands/abaqus.bat

You can add the directory C:/SIMULIA/Commands to the system environment variable Path, or you can create a new system variable named ABAQUS_BAT_PATH, and set the value to the file path of the Abaqus command, i.e., C:/SIMULIA/Commands/abaqus.bat.

Screenshots

  • Create an Abaqus Model

    Model

  • Extract Output Data

    Output

Explore more

For detailed usage of this package, please refer to the documentation.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

abqpy-2021.3.5.tar.gz (9.4 MB view details)

Uploaded Source

Built Distribution

abqpy-2021.3.5-py3-none-any.whl (1.6 MB view details)

Uploaded Python 3

File details

Details for the file abqpy-2021.3.5.tar.gz.

File metadata

  • Download URL: abqpy-2021.3.5.tar.gz
  • Upload date:
  • Size: 9.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.14

File hashes

Hashes for abqpy-2021.3.5.tar.gz
Algorithm Hash digest
SHA256 ff9f2f14db832feed31c7365aad8e9e23105115d159f42c8f9a39c0728726516
MD5 75004599bad625a797a65179dc9271d8
BLAKE2b-256 46025b272b91b5d44dbc2aaef0916cb6cbfe79b58232daf0f3b079b7f8099c0a

See more details on using hashes here.

File details

Details for the file abqpy-2021.3.5-py3-none-any.whl.

File metadata

  • Download URL: abqpy-2021.3.5-py3-none-any.whl
  • Upload date:
  • Size: 1.6 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.14

File hashes

Hashes for abqpy-2021.3.5-py3-none-any.whl
Algorithm Hash digest
SHA256 ec6271860a2df94341810eac707b9c89e1693136e288c72693a391762e90b93b
MD5 2fe537e08ae842eb9eeef7bdeab6ed1f
BLAKE2b-256 f6a0936883e39f1d9dfe24badefd843599678fbec3ef95b49667214b4d650b5f

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page