Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,31 +1,11 @@
# Changelog

This changelog is organized by category, with sections for new features, changes, fixes, and performance improvements. The following table shows which components have updates in each category.

| Component | Features | Changes | Fixes | Performance |
|-----------|----------|---------|-------|-------------|
| Framework | ✅ [15 items](#features_framework) | ✅ [4 items](#changes_framework) | ✅ [33 items](#fixes_framework) | ✅ [9 items](#performance_framework) |
| HGP | ✅ [4 items](#features_hgp) | ✅ [1 item](#changes_hgp) | ✅ [6 items](#fixes_hgp) | ✅ [2 items](#performance_hgp) |
| MAPDL | ✅ [11 items](#features_mapdl) | ✅ [3 items](#changes_mapdl) | ✅ [29 items](#fixes_mapdl) | ✅ [3 items](#performance_mapdl) |
| LSDYNA | ✅ [2 items](#features_lsdyna) | ✅ [2 items](#changes_lsdyna) | ✅ [8 items](#fixes_lsdyna) | ❌ |
| Math | ✅ [1 item](#features_math) | ✅ [2 items](#changes_math) | ✅ [1 item](#fixes_math) | ❌ |
| HDF5 | ✅ [3 items](#features_hdf5) | ✅ [1 item](#changes_hdf5) | ✅ [8 items](#fixes_hdf5) | ❌ |
| CFF | ❌ | ✅ [1 item](#changes_cff) | ✅ [2 items](#fixes_cff) | ❌ |
| Compression | ✅ [1 item](#features_compression) | ❌ | ❌ | ✅ [1 item](#performance_compression) |
| Documentation | ✅ [1 item](#features_documentation) | ❌ | ❌ | ❌ |
| Motion | ✅ [1 item](#features_motion) | ❌ | ❌ | ❌ |
| CGNS | ✅ [1 item](#features_cgns) | ❌ | ❌ | ❌ |
| Engineering Data | ❌ | ✅ [1 item](#changes_engineering_data) | ❌ | ❌ |
| VTK | ❌ | ❌ | ✅ [1 item](#fixes_vtk) | ❌ |

**Legend:**

- ✅ = Updates available in this category
- ❌ = No updates in this category
- Numbers in brackets indicate the count of items in each section
This changelog is organized by category, with sections for new features, changes, fixes, and performance improvements.

## Table of contents

### Features categories

* [Framework](#features_framework)
* [HGP](#features_hgp)
* [MAPDL](#features_mapdl)
Expand All @@ -38,6 +18,7 @@ This changelog is organized by category, with sections for new features, changes
* [CGNS](#features_cgns)

### Changes categories

* [Framework](#changes_framework)
* [HGP](#changes_hgp)
* [MAPDL](#changes_mapdl)
Expand All @@ -48,6 +29,7 @@ This changelog is organized by category, with sections for new features, changes
* [Engineering Data](#changes_engineering_data)

### Fixes categories

* [Framework](#fixes_framework)
* [HGP](#fixes_hgp)
* [MAPDL](#fixes_mapdl)
Expand All @@ -58,6 +40,7 @@ This changelog is organized by category, with sections for new features, changes
* [VTK](#fixes_vtk)

### Performance improvements categories

* [Framework](#performance_framework)
* [HGP](#performance_hgp)
* [MAPDL](#performance_mapdl)
Expand Down
2 changes: 1 addition & 1 deletion 2025R2/dpf-framework-25-r2/toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -1809,4 +1809,4 @@
- name: weighted merge fields by label
href: operator-specifications/utility/weighted_merge_fields_by_label.md
- name: Changelog
href: changelog/changelog-25-r2.md
href: changelog/changelog.md
20 changes: 10 additions & 10 deletions 2025R2/dpf-framework-25-r2/user-guide/dpf-docs-local-preview.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ This guide shows you how to create your own local copy of the DPF Framework docu
This step-by-step guide walks you through:

- How to use basic command-line tools.
- How to create a local website to view your custom documentation.
- How to create a local website to view your DPF Framework HTML documentation.
- How to update the "Operator specifications" section of your documentation based on a custom DPF installation.

## About the command line
Expand All @@ -42,7 +42,8 @@ This guide uses the **command line** (also called terminal or PowerShell on Wind
Create a local website to view DPF Framework documentation in a user-friendly format (like a regular website with navigation and search).
The DPF Framework documentation includes both general reference material and the DPF operators documentation.

You first get the sources for the official documentation at https://github.com/ansys/DevRelDocs, then update them locally, and generate a local website.
First, install the DocFX website builder. Next, clone the official documentation source from [github.com/ansys/DevRelDocs](https://github.com/ansys/DevRelDocs). Use DocFX to generate a local version of the website.


### Step 1: Install the website builder (DocFX)

Expand Down Expand Up @@ -150,7 +151,7 @@ Download and install the latest stable version of Python from the https://www.py

If you want to use older versions of Python, the minimum version supported by ansys-dpf-core is 3.10.

1. **Test your Python installation** by typing:
**Test your Python installation** by typing:

```powershell
python --version
Expand Down Expand Up @@ -217,19 +218,18 @@ You need to install the DPF server software. Select the installation method that
$env:ANSYS_DPF_ACCEPT_LA = "Y"
```

1. **Set your license server** by typing:
2. **Set your license server** by typing:

```powershell
$env:ANSYSLMD_LICENSE_FILE = "1055@your-license-address"
```

**What these do:** Configure DPF to work with your license and permissions. See [Licensing](../getting-started/licensing.md) section for more information.

### Step 4: Update the DPF operators documentation
### Step 3: Update the DPF operators documentation

Next, generate the DPF operators Markdown documentation files. Choose the option that fits your needs.


**Update the current documentation with the default DPF installation:**

Move to the root folder of the ``dpf-framework`` documentation downloaded in section ``Create your DPF Framework HTML documentation``, step ``Get the DPF Framework documentation source files``.
Expand Down Expand Up @@ -278,7 +278,7 @@ Generate the output files for all operators including private operators with the
dpf_generate_operators_doc.exe --include_private
```

#### Optional: Document composites operators
#### Optional: Document Composites operators

Generate the output files for all operators including operators of the ``Composites`` DPF plugin with the ``--include_composites`` command argument:

Expand All @@ -289,7 +289,7 @@ dpf_generate_operators_doc.exe --include_composites
This is useful for installations where the ``Composites`` plugin is present but not loaded by default.
This tells the script to try and load the plugin when starting DPF.

#### Optional: Document composites operators
#### Optional: Document Sound operators

Generate the output files for all operators including operators of the ``Sound`` DPF plugin with the ``--include_sound`` command argument:

Expand Down Expand Up @@ -330,9 +330,9 @@ dpf_generate_operators_doc.exe --plugin "mesh"

**What this does:** Creates documentation only for the specified plugin.

### Step 5: Rebuild the documentation
### Step 4: Rebuild the documentation

Refer to the previous main section "Create your DPF Framework HTML documentation" and "Step 3: Generate a local website" to update the HTML documentation with the new content for DPF operators.
Refer to the previous main section [Create your DPF Framework HTML documentation](#create-your-dpf-framework-html-documentation) and **Step 3: Generate a local website** to update the HTML documentation with the new content for DPF operators.

## Troubleshooting

Expand Down
Loading