netcore-sci 1.0.22

netcore-sci

.NET core sci

• Quickstart
• API Documentation
• Unit tests
• How this project was built

<hr/>

Quickstart

From examples follow example_0001 can be created following these steps:

• create console project

dotnet new console -n example_0001
cd example_0001

• add reference to netcore-sci ( check latest version here )

dotnet add package netcore-sci --version 1.0.21

if prefer to link source code directly to stepin with debugger add project reference instead

dotnet add reference ../../netcore-sci/netcore-sci.csproj

• setup example code

using static System.Math;
using SearchAThing.Sci;
using SearchAThing;

namespace example_0001
{
    class Program
    {
        static void Main(string[] args)
        {
            var tol = 1e-8;
            var R = 100;

            var dxf = new netDxf.DxfDocument();
            var ang = 0d;
            var angStep = 10d.ToRad();
            var angElev = 20d.ToRad();

            var o = Vector3D.Zero;
            var p = new Vector3D(R, 0, 0);

            Circle3D circ = null;

            while (ang < 2 * PI)
            {
                var l = new Line3D(o, p.RotateAboutZAxis(ang));
                var l_ent = l.DxfEntity;
                l_ent.Color = netDxf.AciColor.Cyan;
                dxf.AddEntity(l_ent);

                var arcCS = new CoordinateSystem3D(o, l.V, Vector3D.ZAxis);
                var arc = new Arc3D(tol, arcCS, R, 0, angElev);
                var arc_ent = arc.DxfEntity;
                arc_ent.Color = netDxf.AciColor.Yellow;
                dxf.AddEntity(arc_ent);

                var arc2CS = new CoordinateSystem3D(l.To - R * Vector3D.ZAxis,
                    Vector3D.ZAxis, Vector3D.Zero - l.To);
                var arc2 = new Arc3D(tol, arc2CS, R, 0, PI / 2);
                var arc2_ent = arc2.DxfEntity;
                arc2_ent.Color = netDxf.AciColor.Green;
                dxf.AddEntity(arc2_ent);

                if (circ == null)
                {
                    circ = new Circle3D(tol,
                        CoordinateSystem3D.WCS.Move(Vector3D.ZAxis * arc.To.Z),
                        arc.To.Distance2D(Vector3D.Zero));
                    var circ_ent = circ.DxfEntity;
                    circ_ent.Color = netDxf.AciColor.Yellow;
                    dxf.AddEntity(circ_ent);
                }

                ang += angStep;
            }

            dxf.Viewport.ShowGrid = false;
            dxf.Save("output.dxf");
        }
    }
}

• execute

dotnet run

• result dxf

<img src="examples/example_0001/output.png" width=300>

API Documentation

• 3D Geometry
  • Vector3D
  • Line3D
  • Transform3D
  • CoordinateSystem3D
  • Plane3D
  • Arc3D
  • Circle3D
  • Geometry
  • BBox3D
  • DiscreteSpace
  • DxfKit
  • Polygon
• Extension methods
• Python wrapper
• Measure unit and physical quantities
  • Measure
  • PhysicalQuantity
  • PQCollection
  • MeasureUnit
  • MUDomain
  • MUCollection

Unit tests

• debugging unit tests
  • from vscode just run debug test from code lens balloon
• executing all tests
  • from solution root folder dotnet test
• testing coverage
  • from vscode run task ( ctrl+shift+p ) Tasks: Run Task then test with coverage ( .NET Core Test Explorer extension required then move to some file eg. Vector3D.cs and click on Add Watch from bottom bar )

How this project was built

mkdir netcore-sci
cd netcore-sci

dotnet new sln
dotnet new classlib -n netcore-sci

cd netcore-sci
dotnet add package netcore-util --version 1.0.2
dotnet add package netcore-psql-util --version 1.0.3
dotnet add package netDXF.Standard --version 2.1.1
cd ..

dotnet new xunit -n test
cd test
dotnet add reference ../netcore-sci/netcore-sci.csproj
cd ..

dotnet sln netcore-sci.sln add netcore-sci/netcore-sci.csproj
dotnet sln netcore-sci.sln add test/test.csproj
dotnet restore
dotnet build
dotnet test test/test.csproj