Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rexcardan/ESAPIX
Extension library for the Varian Eclipse Scripting API
https://github.com/rexcardan/ESAPIX
esapi medical-physics varian
Last synced: about 1 month ago
JSON representation
Extension library for the Varian Eclipse Scripting API
- Host: GitHub
- URL: https://github.com/rexcardan/ESAPIX
- Owner: rexcardan
- License: mit
- Created: 2016-07-07T20:28:48.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2022-12-08T03:44:21.000Z (about 2 years ago)
- Last Synced: 2024-11-03T05:09:59.893Z (about 1 month ago)
- Topics: esapi, medical-physics, varian
- Language: C#
- Size: 15.4 MB
- Stars: 51
- Watchers: 16
- Forks: 45
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-medphys - ESAPIX -  An open source extension library for the Varian Eclipse Scripting API that contains extra methods, and bootstrapping frameworks. (Libraries)
README
ESAPIX
===================
ESAPIX is an open source extension library for the Varian Eclipse Scripting API that contains extra methods, and bootstrapping frameworks to quickly develop applications for research and clinical use.
It has no affiliation with Varian Medical Systems. It provides implementations for multithreading, asynchronous calls,
debugging plugins, and with the ESAPIX.Bootstrapping library : dependency injection, and view model "auto finding" through the Prism 6 library.
## Supported Eclipse Versions
* 11
* 13.6
* 13.7
* 15.0
* 15.1
* 15.5
* 15.6
* 16.1
[](https://github.com/ellerbrock/open-source-badge/)
## Where is the ESAPIX Bootstrapper
The bootstrapper used to be used to create a basic WPF application. Currently we recommend just using the WPF example as the starting place of your project and no longer using the Bootstrapping library. Clone https://github.com/rexcardan/ESAPIX_WPF_Example and start your project from there
----------
# Getting Started
1. Install the appropriate ESAPIX library (Version) through NuGet.
* Right click your project >> Manage NuGet Packages >> (Search "ESAPI")
2. In your project, instead of calling:
```cs
var app = Application.CreateApplication("...");
```
Call :
```cs
var sac = new StandAloneContext(()=>Application.CreateApplication("..."));
```
## StandAloneContext vs VMS...Application
Using ESAPIX StandAloneContext (SAC) wraps the real Varian classes in a thread controlled environment using [Facades]("https://rexcardan.github.io/ESAPIX/articles/facades.html"). This trick allows for
using easy multithreading since ESAPIX will handle calling VMS proper classes on the correct thread. Additionally, these lightweight wrappers (Facades) can be used to
mock Varian classes for [unit testing](https://www.youtube.com/watch?v=HUuCU2Hplgw) and [offline development]("https://www.youtube.com/watch?v=pxazDPo3Ugc"). Also, the data can be quickly serialized
into JSON using the [FacadeSerializer](https://github.com/rexcardan/ESAPIX/blob/master/ESAPIX/Facade/Serialization/FacadeSerializer.cs) class.
## Contributing
Most of all, ESAPIX is a unified, open source framework that is designed to be used and contributed to by the medical physics community. It uses the MIT open source license to ensure that
code can be used in whatever tools you need in the fight against cancer. If you are interested in contributing code, please [see an example]("https://www.youtube.com/watch?v=Zq2wasAW6iw") of submitting code to this repository.
## WPF Application
### Video Tutorial (Deprecated. For versions <1.5.0.0)
[](https://www.youtube.com/watch?v=qPVIR8Jxs94)
To dive deeper, check out [more examples and API documentation](https://rexcardan.github.io/ESAPIX/).