Skip to main content

Type hints for Abaqus/Python scripting

Project description

abqpy 2022

Documentation Status Documentation Status Tests CodeQL Total alerts Language grade: Python PyPI pyversions GitHub release (latest by date) PyPI download month

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

Install A Specific Version

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

pip install abqpy==2022.3.2
conda install -c haiiliin abqpy=2022.3.2

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

pip install abqpy==2022.*

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 the following packages:

pip install ipynbname  # to read the file name of the notebook
pip install notebook
pip install jupyterlab

Or use conda to install (the ipynbname package is only distributed in PyPI, so you have to install it using pip):

conda install jupyterlab
conda install jupyter notebook

Try the following command to make sure the jupyter command is available.

jupyter --version

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
python setup.py install

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-2022.3.2.tar.gz (9.5 MB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for abqpy-2022.3.2.tar.gz
Algorithm Hash digest
SHA256 102c16b75ec650f04abe8004ef1fdfde3050dd4b61b7b8dcfb142038df1bc9fc
MD5 515ec29f8ee101bc3ccb34834d59102e
BLAKE2b-256 33eedf572caae0279eff25c76360b279f17ecfc3ab818de19379717865aea32b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: abqpy-2022.3.2-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-2022.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 3684eefd70f29df0df96e334cf5d10a8634a0334a8e360b01a0e6a33a86fb76a
MD5 a7643a3b4d80febafdc661e773dbcb14
BLAKE2b-256 5c426e252b5554b25f6eb7106db996f058cf3fd1c98c287cae8521c1e59a4dc1

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