# Moldflow API
[](https://badge.fury.io/py/moldflow)
[](https://pypi.org/project/moldflow/)
[](https://opensource.org/licenses/Apache-2.0)
[](https://github.com/Autodesk/moldflow-api/actions)
Moldflow API is a Python wrapper library for the Synergy API, designed to simplify interactions with Autodesk Moldflow Synergy. This library provides a clean, pythonic interface to Moldflow's simulation capabilities, making it easier to integrate Moldflow functionality into your Python applications.
## Prerequisites
Before you begin, ensure you have:
- Windows 10/11
- Python 3.10.x - 3.13.x
- Autodesk Moldflow Synergy 2026.0.1 or later
## Install
```sh
python -m pip install moldflow
```
## Quick Start
```python
from moldflow import Synergy
# Initialize the API
synergy = Synergy()
# Example: Get version information
version = synergy.version
print(f"Moldflow Synergy version: {version}")
```
See the [full documentation](https://autodesk.github.io/moldflow-api) for more in-depth examples.
## For Development
### 1. Clone the Repository
```sh
git clone https://github.com/Autodesk/moldflow-api.git
```
### 2. Navigate to the Repository
```sh
cd moldflow-api
```
### 3. Set Up Development Environment
```sh
python -m pip install -r requirements.txt
pre-commit install
```
## Usage
### Building the Package
```sh
python run.py build
```
### Building the Documentation
```sh
python run.py build-docs
```
Options:
- `--skip-build` (`-s`): Skip building before generating docs
The documentation can be accessed locally by opening the [index.html](docs/build/html/index.html) in the [html](docs/build/html/) folder.
### Running the Formatter
```sh
python run.py format
```
Options:
- `--check`: Check the code formatting without making changes
### Running Lint Checks
```sh
python run.py lint
```
Options:
- `--skip-build` (`-s`): Skip building before linting
### Running Tests
```sh
python run.py test
```
| Option | Alias | Description |
|--------------------|:------:|------------------------------------------------------------------------|
| `<tests>...` | - | Test files/directories path |
| `--marker` | `-m` | Marker [unit, integration, core] |
| `--skip-build` | `-s` | Skip building before testing |
| `--keep-files` | `-k` | Don't remove the .coverage files after testing [for report generation] |
| `--unit` | - | Run Unit Tests |
| `--core` | - | Run Core Functionality Tests |
| `--integration` | - | Run Integration Tests |
| `--quiet` | `q` | Simple test output |
#### Flag Combinations
| Flag Combination | Runs Unit | Runs Core | Runs Integration | Runs Custom Marker |
|-------------------------------------|:---------:|:---------:|:-----------------:|:------------------:|
| Default (no flags) | ✅ | ✅ | ❌ | ❌ |
| `--unit` | ✅ | ❌ | ❌ | ❌ |
| `--core` | ❌ | ✅ | ❌ | ❌ |
| `--integration` | ❌ | ❌ | ✅ | ❌ |
| `--unit --core` | ✅ | ✅ | ❌ | ❌ |
| `--unit --integration` | ✅ | ❌ | ✅ | ❌ |
| `--core --integration` | ❌ | ✅ | ✅ | ❌ |
| `--unit --core --integration` | ✅ | ✅ | ✅ | ❌ |
| `--all` | ✅ | ✅ | ✅ | ❌ |
| `--marker foo` | ❌ | ❌ | ❌ | ✅ (`foo`) |
| `--unit --marker bar` | ✅ | ❌ | ❌ | ✅ (`bar`) |
| `--integration --marker baz` | ❌ | ❌ | ✅ | ✅ (`baz`) |
### Running specific test files
```sh
python run.py test tests/api/unit_tests/test_unit_material_finder.py
```
## API Documentation
For detailed API documentation, please visit our [online documentation](https://autodesk.github.io/moldflow-api/).
Key modules include:
- `synergy`: Main interface to Moldflow Synergy
- `study_doc`: Study document management
- `mesh_editor`: Mesh manipulation and analysis
- `material_finder`: Material database interactions
- `plot`: Results visualization
## Contributing
We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details on how to contribute to this project. Here's a quick overview:
1. Fork the repository
2. Create a feature branch (`git checkout -b feature/amazing-feature`)
3. Make your changes
4. Run tests (`python run.py test`)
5. Commit your changes (`git commit -m 'Add amazing feature'`)
6. Push to the branch (`git push origin feature/amazing-feature`)
7. Open a Pull Request
## Versioning
We use [Semantic Versioning](https://semver.org/). For available versions, see the [tags on this repository](https://github.com/Autodesk/moldflow-api/tags).
## License
This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.
## Support
- **Documentation**: [Full documentation available online](https://autodesk.github.io/moldflow-api)
- **Issues**: Report bugs and request features through [GitHub Issues](https://github.com/Autodesk/moldflow-api/issues)
- **Security**: For security issues, please see our [Security Policy](SECURITY.md)
- **Discussions**: Join our [GitHub Discussions](https://github.com/Autodesk/moldflow-api/discussions) for questions and community support
## Code of Conduct
This project adheres to the Contributor Covenant [code of conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code.
Raw data
{
"_id": null,
"home_page": "https://github.com/Autodesk/moldflow-api",
"name": "moldflow",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.14,>=3.10",
"maintainer_email": null,
"keywords": "moldflow, autodesk, cae, simulation, manufacturing, injection molding, plastic injection, analysis, automation, api, synergy",
"author": "Autodesk Inc.",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/ca/01/06ecdcdf97444bd163a19c190e8bcb5036f10d7d79bd168cf3816e7d19a1/moldflow-26.0.2.tar.gz",
"platform": null,
"description": "# Moldflow API\r\n\r\n[](https://badge.fury.io/py/moldflow)\r\n[](https://pypi.org/project/moldflow/)\r\n[](https://opensource.org/licenses/Apache-2.0)\r\n[](https://github.com/Autodesk/moldflow-api/actions)\r\n\r\nMoldflow API is a Python wrapper library for the Synergy API, designed to simplify interactions with Autodesk Moldflow Synergy. This library provides a clean, pythonic interface to Moldflow's simulation capabilities, making it easier to integrate Moldflow functionality into your Python applications.\r\n\r\n## Prerequisites\r\n\r\nBefore you begin, ensure you have:\r\n- Windows 10/11\r\n- Python 3.10.x - 3.13.x\r\n- Autodesk Moldflow Synergy 2026.0.1 or later\r\n\r\n## Install\r\n```sh\r\npython -m pip install moldflow\r\n```\r\n\r\n## Quick Start\r\n\r\n```python\r\nfrom moldflow import Synergy\r\n\r\n# Initialize the API\r\nsynergy = Synergy()\r\n\r\n# Example: Get version information\r\nversion = synergy.version\r\nprint(f\"Moldflow Synergy version: {version}\")\r\n```\r\n\r\nSee the [full documentation](https://autodesk.github.io/moldflow-api) for more in-depth examples.\r\n\r\n## For Development\r\n\r\n### 1. Clone the Repository\r\n\r\n```sh\r\ngit clone https://github.com/Autodesk/moldflow-api.git\r\n```\r\n\r\n### 2. Navigate to the Repository\r\n\r\n```sh\r\ncd moldflow-api\r\n```\r\n\r\n### 3. Set Up Development Environment\r\n\r\n```sh\r\npython -m pip install -r requirements.txt\r\npre-commit install\r\n```\r\n\r\n## Usage\r\n\r\n### Building the Package\r\n\r\n```sh\r\npython run.py build\r\n```\r\n\r\n### Building the Documentation\r\n```sh\r\npython run.py build-docs\r\n```\r\n\r\nOptions:\r\n- `--skip-build` (`-s`): Skip building before generating docs\r\n\r\nThe documentation can be accessed locally by opening the [index.html](docs/build/html/index.html) in the [html](docs/build/html/) folder.\r\n\r\n### Running the Formatter\r\n\r\n```sh\r\npython run.py format\r\n```\r\n\r\nOptions:\r\n- `--check`: Check the code formatting without making changes\r\n\r\n### Running Lint Checks\r\n\r\n```sh\r\npython run.py lint\r\n```\r\n\r\nOptions:\r\n- `--skip-build` (`-s`): Skip building before linting\r\n\r\n### Running Tests\r\n\r\n```sh\r\npython run.py test\r\n```\r\n\r\n| Option | Alias | Description |\r\n|--------------------|:------:|------------------------------------------------------------------------|\r\n| `<tests>...` | - | Test files/directories path |\r\n| `--marker` | `-m` | Marker [unit, integration, core] |\r\n| `--skip-build` | `-s` | Skip building before testing |\r\n| `--keep-files` | `-k` | Don't remove the .coverage files after testing [for report generation] |\r\n| `--unit` | - | Run Unit Tests |\r\n| `--core` | - | Run Core Functionality Tests |\r\n| `--integration` | - | Run Integration Tests |\r\n| `--quiet` | `q` | Simple test output |\r\n\r\n#### Flag Combinations\r\n\r\n| Flag Combination | Runs Unit | Runs Core | Runs Integration | Runs Custom Marker |\r\n|-------------------------------------|:---------:|:---------:|:-----------------:|:------------------:|\r\n| Default (no flags) | \u2705 | \u2705 | \u274c | \u274c |\r\n| `--unit` | \u2705 | \u274c | \u274c | \u274c |\r\n| `--core` | \u274c | \u2705 | \u274c | \u274c |\r\n| `--integration` | \u274c | \u274c | \u2705 | \u274c |\r\n| `--unit --core` | \u2705 | \u2705 | \u274c | \u274c |\r\n| `--unit --integration` | \u2705 | \u274c | \u2705 | \u274c |\r\n| `--core --integration` | \u274c | \u2705 | \u2705 | \u274c |\r\n| `--unit --core --integration` | \u2705 | \u2705 | \u2705 | \u274c |\r\n| `--all` | \u2705 | \u2705 | \u2705 | \u274c |\r\n| `--marker foo` | \u274c | \u274c | \u274c | \u2705 (`foo`) |\r\n| `--unit --marker bar` | \u2705 | \u274c | \u274c | \u2705 (`bar`) |\r\n| `--integration --marker baz` | \u274c | \u274c | \u2705 | \u2705 (`baz`) |\r\n\r\n\r\n### Running specific test files\r\n\r\n```sh\r\npython run.py test tests/api/unit_tests/test_unit_material_finder.py\r\n```\r\n\r\n## API Documentation\r\n\r\nFor detailed API documentation, please visit our [online documentation](https://autodesk.github.io/moldflow-api/).\r\n\r\nKey modules include:\r\n- `synergy`: Main interface to Moldflow Synergy\r\n- `study_doc`: Study document management\r\n- `mesh_editor`: Mesh manipulation and analysis\r\n- `material_finder`: Material database interactions\r\n- `plot`: Results visualization\r\n\r\n## Contributing\r\n\r\nWe welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details on how to contribute to this project. Here's a quick overview:\r\n\r\n1. Fork the repository\r\n2. Create a feature branch (`git checkout -b feature/amazing-feature`)\r\n3. Make your changes\r\n4. Run tests (`python run.py test`)\r\n5. Commit your changes (`git commit -m 'Add amazing feature'`)\r\n6. Push to the branch (`git push origin feature/amazing-feature`)\r\n7. Open a Pull Request\r\n\r\n## Versioning\r\n\r\nWe use [Semantic Versioning](https://semver.org/). For available versions, see the [tags on this repository](https://github.com/Autodesk/moldflow-api/tags).\r\n\r\n## License\r\n\r\nThis project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.\r\n\r\n## Support\r\n\r\n- **Documentation**: [Full documentation available online](https://autodesk.github.io/moldflow-api)\r\n- **Issues**: Report bugs and request features through [GitHub Issues](https://github.com/Autodesk/moldflow-api/issues)\r\n- **Security**: For security issues, please see our [Security Policy](SECURITY.md)\r\n- **Discussions**: Join our [GitHub Discussions](https://github.com/Autodesk/moldflow-api/discussions) for questions and community support\r\n\r\n## Code of Conduct\r\n\r\nThis project adheres to the Contributor Covenant [code of conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code.\r\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Moldflow API Library",
"version": "26.0.2",
"project_urls": {
"Documentation": "https://autodesk.github.io/moldflow-api",
"Homepage": "https://github.com/Autodesk/moldflow-api",
"Issues": "https://github.com/Autodesk/moldflow-api/issues",
"Security": "https://www.autodesk.com/trust/security/vulnerability-disclosure-policy",
"Source": "https://github.com/Autodesk/moldflow-api"
},
"split_keywords": [
"moldflow",
" autodesk",
" cae",
" simulation",
" manufacturing",
" injection molding",
" plastic injection",
" analysis",
" automation",
" api",
" synergy"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "c7f927fc72991cdbbc5b89890d8af037626f66e9ca9ff734e4f8f42e6f0a7a4a",
"md5": "5bf77c22f871cee3497f75a5438ffcce",
"sha256": "980f3fa1bd1f6366406c214c8e9fed590c9512f367df245cd3608b25b128b459"
},
"downloads": -1,
"filename": "moldflow-26.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5bf77c22f871cee3497f75a5438ffcce",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.14,>=3.10",
"size": 159247,
"upload_time": "2025-10-10T05:08:27",
"upload_time_iso_8601": "2025-10-10T05:08:27.522202Z",
"url": "https://files.pythonhosted.org/packages/c7/f9/27fc72991cdbbc5b89890d8af037626f66e9ca9ff734e4f8f42e6f0a7a4a/moldflow-26.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "ca0106ecdcdf97444bd163a19c190e8bcb5036f10d7d79bd168cf3816e7d19a1",
"md5": "4db007862e084605c0b3fb8dcec48aa0",
"sha256": "1fc52350c4188403419d3d06a83455662ff2401076b9d7c5732849b192e02236"
},
"downloads": -1,
"filename": "moldflow-26.0.2.tar.gz",
"has_sig": false,
"md5_digest": "4db007862e084605c0b3fb8dcec48aa0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.14,>=3.10",
"size": 129094,
"upload_time": "2025-10-10T05:08:28",
"upload_time_iso_8601": "2025-10-10T05:08:28.707862Z",
"url": "https://files.pythonhosted.org/packages/ca/01/06ecdcdf97444bd163a19c190e8bcb5036f10d7d79bd168cf3816e7d19a1/moldflow-26.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-10 05:08:28",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Autodesk",
"github_project": "moldflow-api",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "black",
"specs": [
[
"==",
"25.1.0"
]
]
},
{
"name": "build",
"specs": [
[
"==",
"1.2.2.post1"
]
]
},
{
"name": "coverage",
"specs": [
[
"==",
"7.6.12"
]
]
},
{
"name": "docopt",
"specs": [
[
"==",
"0.6.2"
]
]
},
{
"name": "packaging",
"specs": [
[
"==",
"24.2"
]
]
},
{
"name": "pathspec",
"specs": [
[
"==",
"0.12.1"
]
]
},
{
"name": "polib",
"specs": [
[
"==",
"1.2.0"
]
]
},
{
"name": "pre-commit",
"specs": [
[
"==",
"4.2.0"
]
]
},
{
"name": "pydata-sphinx-theme",
"specs": [
[
"==",
"0.16.1"
]
]
},
{
"name": "pylint",
"specs": [
[
"==",
"3.3.4"
]
]
},
{
"name": "pytest",
"specs": [
[
"==",
"8.3.4"
]
]
},
{
"name": "sphinx",
"specs": [
[
"==",
"8.1.3"
]
]
},
{
"name": "sphinx-autodoc-typehints",
"specs": [
[
"==",
"3.0.1"
]
]
},
{
"name": "twine",
"specs": [
[
"==",
"6.1.0"
]
]
},
{
"name": "PyGithub",
"specs": [
[
"==",
"2.7.0"
]
]
}
],
"lcname": "moldflow"
}
JSON
