Skip to content

Commit

Permalink
🚑 update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Marco-Pellegrino committed Oct 29, 2024
1 parent 19328b4 commit 08c26cf
Show file tree
Hide file tree
Showing 6 changed files with 8 additions and 147 deletions.
Binary file removed FemDesign.Examples/Python/FemDesign.Core.dll
Binary file not shown.
Binary file removed FemDesign.Examples/Python/FuzzySharp.dll
Binary file not shown.
Binary file removed FemDesign.Examples/Python/Newtonsoft.Json.dll
Binary file not shown.
131 changes: 0 additions & 131 deletions FemDesign.Examples/Python/using_pythonnet.py

This file was deleted.

11 changes: 3 additions & 8 deletions FemDesign.Examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,16 +23,11 @@ With Dynamo installed, any of the Dynamo examples are ready to run. Download an
The examples are ready to run out-of-the-box, but you might have to set a file path or file name. You'll know either from instructions in the file, or because some components give an error.

### 🐍 Python
The python example folder contains an example (`using_pythonnet.py`) on how to run the C# (`FemDesign.Core`) API from Python. This example uses the python package Python.NET (clr) (http://pythonnet.github.io/).

**NOTE**: A complete Python wrapper is [planned in the future](https://github.com/strusoft/femdesign-api/issues/221), but pythonnet can be used already today to access all of the functionality of the C# API.

The example have been tested using
- IronPython 2.7 (pythonnet pre-installed)
- CPython 3.7 (with [pip package pythonnet](https://pypi.org/project/pythonnet/))
`pip install FEM-Design` to install the library and any of the python examples are ready to run.

## Maintenance
The examples and samples here are created and mainatained by StruSoft.
The examples and samples here are created and maintained by StruSoft.

## Questions and feedback
If you have any questions regarding the examples and how they work, feel free to contact us. We also welcome any feedback, as well as suggestions for future examples. You can reach us at [email protected] or at https://strusoft.freshdesk.com/en/support/tickets/new.

Expand Down
13 changes: 5 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,10 @@

[![NuGet Downloads](https://img.shields.io/nuget/dt/FemDesign.Core)](https://www.nuget.org/packages/FemDesign.Core)



# femdesign-api
This repository contains source code for the FEM-Design API wrapper. It consists of the `C#`-Core together with the `Dynamo` and `Grasshopper` plugins.

## 🚗 Road-map

https://github.com/strusoft/femdesign-api/milestones

## Installation
Expand All @@ -28,31 +25,31 @@ Either
- Download the grasshopper package with [Package Manager](https://femdesign-api-docs.onstrusoft.com/docs/grasshopper/get-started/#installation)
- Or download it manually by downloading `FemDesign.Grasshopper.zip` from [latest release](https://github.com/strusoft/femdesign-api/releases/latest), unblock the file and unzip to the grasshopper libraries folder (e.g `C:\Users\USERNAME\AppData\Roaming\Grasshopper\Libraries`).

### 🐍 Python
There are multiple ways to install Python, but one of them is to download the installer from [Python.org](https://www.python.org/downloads/).

### 🤖 Dynamo (Deprecated)
Either
- Install it from within Dynamo using Online Package Search. Search for `FemDesign`. (Guide on [installing dynamo package](https://www.dynamonow.com/downloading-installing-packages/))
- Or Install it manually by downloading `FemDesign.Dynamo.zip` from [latest release](https://github.com/strusoft/femdesign-api/releases/latest), unblock the file and unzip to the dynamo package folder of the version of Revit/Dynamo of your choice (e.g `C:\Users\USERNAME\AppData\Roaming\Dynamo\Dynamo Revit\2.6\packages` for Dynamo Revit 2.6 etc.)

_**NOTE:** The Dynamo package is no longer being actively maintained, and the most recently tested version is 21.6.0._

### 🐍 Python
There are multiple ways to install Python, but one of them is to download the installer from [Python.org](https://www.python.org/downloads/).

## Examples
Examples can be found in the folder [FemDesign.Examples/](https://github.com/strusoft/femdesign-api/tree/master/FemDesign.Examples). More examples are planned to be added in the future.

## Documentation
[FEM-Design API docs](https://femdesign-api-docs.onstrusoft.com)

## Contributing
Feel free to fork this repo as you seem fit. Please let us know with an issue what feature you want and how you plan on implement it and we (the [authors](#Authors)) will guide you.
Feel free to fork this repo as you seem fit. Please let us know with an issue what feature you want and how you plan on implement it and we (the [authors](#Authors)) will guide you.
If you want to contribute please follow our [contribution guide](https://github.com/strusoft/femdesign-api/wiki/Contribute).

## Versioning
Future versioning will be using the following structure: `major.minor.patch` where major follows the FEM-Design version.

## Authors
The FEM-Design API repository is developed and maintained by [StruSoft](https://strusoft.com/).
The FEM-Design API repository is developed and maintained by [StruSoft](https://strusoft.com/).

## Disclaimer
In addition to the disclaimer under the license ([LICENSE.md](LICENSE)) - All files and related documentation is for illustrative and educational purposes and may not interact with FEM-Design in a reliable way depending on your version, installation and content of the files. Furthermore, Strusoft won´t guarantee full support of the package. 😊
Expand Down

0 comments on commit 08c26cf

Please sign in to comment.