Skip to content

Commit

Permalink
update invalid links #327
Browse files Browse the repository at this point in the history
  • Loading branch information
atomczak authored Aug 23, 2024
1 parent 220e84b commit b12e392
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions Documentation/UserManual/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,25 @@

<img src="Graphics/IDS-logo-with-letters.png" alt="IDS Logo" width="300"/>

**Information Delivery Specification (IDS)** is a buildingSMART standard for specifying and checking simple information requirements from IFC models. It is designed as a free, lightweight, standardised approach to model checking.
**Information Delivery Specification (IDS)** is a buildingSMART standard for specifying and checking simple information requirements from IFC models. It is designed as a free, lightweight, standardised approach to model checking. Read more on the official website: https://www.buildingsmart.org/standards/bsi-standards/information-delivery-specification-ids/

## Introduction

An IDS is a file format ending in `.ids` containing a list of information **Specifications**. For example, a single **Specification** might say that "_all walls must have a fire rating property_". Model authors receiving an IDS file can use it to ensure all required information is provided for each **Specification**. Model recipients may use the IDS file to check whether the IFC model meets all of the **Specifications**. Reports may also be generated to list the results of **Specification** compliance checks.

![IDS Diagram](Graphics/ids-diagram.png)

IDS file creation tools and model checking tools are provided by many [software vendors](https://technical.buildingsmart.org/resources/software-implementations/). You can write your own customised IDS **Specifications** from scratch or start from a [public IDS template](todo). Any IFC model produced from any software can be checked by an IDS file.
IDS file creation tools and model checking tools are provided by many [software vendors](https://technical.buildingsmart.org/ids-software-implementations/). Any IFC model produced from any software can be checked against an IDS file.

## Beginners tutorial

1. [Download and install your favourite software](https://technical.buildingsmart.org/resources/software-implementations/) that supports IDS from the software vendors directory. There is software available for Windows, Mac, and Linux.
2. [Download a sample IDS file](library/sample.ids). This IDS file has two **Specifications**. The first specifies that _the project name should be TEST_. The second specifies that _all walls must have a fire rating property_.
3. [Download a sample IFC model to check](library/sample.ifc). This IFC model has "TEST" as the project name, which satisfies the first **Specification**. However, some walls have a fire rating property, and others do not.
4. Load both the IDS and the IFC in your software, and begin the checking process.
1. Choose software that supports IDS (see [list of tools supporting IDS](https://technical.buildingsmart.org/ids-software-implementations/)).
2. Download a [sample IDS file](../Examples/IDS_wooden-windows.ids).
3. Download a [sample IFC model](../Examples/IDS_wooden-windows_IFC.ifc) to check against the IDS.
4. Load both the IDS and the IFC in your software and begin the checking process.
5. You should obtain a report of all the non-compliances.

That's it! You may also find more sample IDS templates in the [buildingSMART IDS Template Directory](https://github.com/buildingSMART/IDS/tree/master/Development) and more sample IFC models in the [buildingSMART IFC model directory](https://github.com/buildingSMART/Sample-Test-Files).
That's it! You may also find more sample IDS files in the [Examples](../Examples).

If you need help, please feel free to ask for help on the [buildingSMART Forums](https://forums.buildingsmart.org/).

Expand Down

0 comments on commit b12e392

Please sign in to comment.