BioFSharp.Visualization

A template repository for creating an extension package for BioFSharp.

Content

• src/BioFSharp.Visualization: The main project folder. Contains a library with BioFSharp core dependency.
• tests/BioFSharp.Visualization.Tests: The test project folder. Contains a XUnit test project
• build/build.fsproj: A FAKE build project that handles building, testing, packaging, publishing, etc.
• docs: the docs folder contains an example index.fsx file with simple documentation boilerplate.

Setup

Here is a list of things you should/might want to do after setting up a repo with this template:

Important

Whenever you change a project file name or folder, make sure to fix the solution registration afterwards.

• Rename some things: Replace XYZ with the name of your package
  • PackageTemplate.sln
  • src/BioFSharp.Visualization
  • src/BioFSharp.Visualization/BioFSharp.Visualization.fsproj
    • Rename and add nuget package metadata
  • tests/BioFSharp.Visualization
  • tests/BioFSharp.Visualization.Tests/BioFSharp.Visualization.Tests.fsproj
    • Also make sure to fix the project reference to BioFSharp.Visualization when renamed
  • in build/ProjectInfo.fs:
    • Set project name:

      let project = "BioFSharp.Visualization" // replace with the name of your project

    • Set git owner:

      let gitOwner = "BioFSharp" // replace with github account name or organization where repo is hosted if necessary

    • fix test project path:

      let testProjects = 
      [
          "tests/BioFSharp.Visualization.Tests/BioFSharp.Visualization.Tests.fsproj" // replace with the name of your test project
      ]

  • in .github/workflows/build-and-test.yml: change codecov slug
• If needed, change the target framework of the project. it currently targets .netstandard2.0 for maximum backwards compatibility, might want to target a newer .net version if you need a specific API.

Development

General

BioFSharp repositories usually folllow this structure:

root
│   📄<project name>.sln
│   📄build.cmd
│   📄build.sh
├───📁build
├───📁docs
├───📁src
|   └───📁<project name>
└───tests
    └───📁<testproject name>

• .sln is the root solution file.
• build contains a FAKE build project with targets for building, testing and packaging the project.
• build/sh and build.cmd in the root are shorthand scripts to execute the buildproject.
• docs contains the documentation in form of literate scripts and notebooks.
• src contains folders with the source code of the project(s).
• tests contains folders with test projects.

Build

just call build.sh or build.cmd depending on your OS.

Test

build.sh runtests

build.cmd runtests

Create Nuget package

build.sh pack

build.cmd pack

Docs

You can watch locally with hot reload via

build.sh watchdocs

build.cmd watchdocs