https://github.com/fornever/umov.csxcad

CLI-based CSXCAD parser and writer.
https://github.com/fornever/umov.csxcad

Last synced: 15 days ago
JSON representation

CLI-based CSXCAD parser and writer.

• Host: GitHub
• URL: https://github.com/fornever/umov.csxcad
• Owner: ForNeVeR
• Created: 2015-12-02T15:13:29.000Z (almost 9 years ago)
• Default Branch: develop
• Last Pushed: 2017-07-10T16:26:36.000Z (over 7 years ago)
• Last Synced: 2024-10-14T02:01:13.580Z (about 1 month ago)
• Language: F#
• Homepage:
• Size: 95.7 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 7
• Metadata Files:
  • Readme: Readme.md

Awesome Lists containing this project

README

        
Umov.Csxcad [![Build status][appveyor-build-status]][appveyor-build] [![Status Ventis][status-ventis]][andivionian-status-classifier] [![Nuget Package][nuget-badge]][nuget-umov-csxcad]

============

This is a part of the [Umov project][umov] responsible for parsing and

creating [CSXCAD][csxcad] and [openEMS][open-ems] files.

Debug

-----

To debug the library source in Visual Studio using the PDB from the NuGet

package, you need to enable source server support [as stated in GitLink

manual][gitlink-manual].

Build

-----

This project uses [Paket][paket] dependency manager. Before opening the solution

or building the project, you should install Paket (or Paket bootstrapper) into

`.paket` directory and download the dependencies using the following commands:

    $ ./.paket/paket.bootstrapper.exe

    $ ./.paket/paket.exe restore

For convenience, there is a script `Scripts/Install.ps1` that will download

Paket bootstrapper and call these commands automatically.

Consult the script documentation to discover its parameters.

Package

-------

To build [Nuget][nuget] package for Umov, use the script `Scripts/Package.ps1`.

If you want to push this package to the Nuget feed, use

`Scripts/Push-Package.ps1`.

⚠ Please make sure you have a recent version of NuGet installed (4.1 should be

okay), e.g. by [installing it from Chocolatey][choco-nuget].

Sample XML generation

---------------------

Currently `Umov.Csxcad` relies on [CSXCAD][csxcad] and [openEMS][open-ems]

samples generated by [Octave][octave] / MATLAB openEMS interface with some

static additions. These samples are concatenated and stored in

`Tools/Sample.lxml` file (which is not a well-formed XML but an XML element list

for [`XMLProvider`][fsharp-data-xml-provider]).

Raw XML contents of `CSX.xml` and `openEMS.xml` are also used for the unit

tests.

To generate these sample files, install Octave and openEMS, and run the attached

script file. For example:

    $ cd Tools

    $ octave-cli Generate-XML.m

Licensing

---------

Copyright © 2015–2017 Friedrich von Never 

This software may be at the user's choice used under the terms of:

- WTFPL (see `WTFPL.md` for details) [![WTFPL][wtfpl-badge]][wtfpl]

- MIT (see `MIT.md` for details)

[andivionian-status-classifier]: https://github.com/ForNeVeR/andivionian-status-classifier

[appveyor-build]: https://ci.appveyor.com/project/ForNeVeR/umov-csxcad/branch/develop

[choco-nuget]: https://chocolatey.org/packages/NuGet.CommandLine

[csxcad]: https://github.com/thliebig/CSXCAD

[fsharp-data-xml-provider]: http://fsharp.github.io/FSharp.Data/library/XmlProvider.html

[gitlink-manual]: https://github.com/GitTools/GitLink#gitlink

[nuget]: https://www.nuget.org/

[nuget-umov-csxcad]: https://www.nuget.org/packages/Umov.Csxcad/

[octave]: https://www.gnu.org/software/octave/

[open-ems]: http://openems.de/

[paket]: https://fsprojects.github.io/Paket/index.html

[umov]: https://github.com/ForNeVeR/Umov

[wtfpl]: http://www.wtfpl.net/

[appveyor-build-status]: https://ci.appveyor.com/api/projects/status/hg2hjvmhwmiwf7q9/branch/develop?svg=true

[nuget-badge]: https://img.shields.io/nuget/vpre/Umov.Csxcad.svg

[status-ventis]: https://img.shields.io/badge/status-ventis-yellow.svg

[wtfpl-badge]: http://www.wtfpl.net/wp-content/uploads/2012/12/wtfpl-badge-2.png