cobarslink

A Mathematica interface for CoBarS

https://github.com/henrikschumacher/cobarslink

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (10.4%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

A Mathematica interface for CoBarS

Basic Info
  • Host: GitHub
  • Owner: HenrikSchumacher
  • License: mit
  • Language: Mathematica
  • Default Branch: main
  • Homepage:
  • Size: 26.6 MB
Statistics
  • Stars: 0
  • Watchers: 2
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Created over 3 years ago · Last pushed 11 months ago
Metadata Files
Readme License Citation

README.md

CoBarSLink

by Jason Cantarella and Henrik Schumacher

A Mathematica interface for CoBarS, a C++ library for Monte-Carlo sampling of cylic polygons with prescribed edge lengths in any dimension.

Installation

To make sure that all submodules are cloned, too, please clone by running the following in the command line:

git clone --depth 1 --recurse-submodules --shallow-submodules git@github.com:HenrikSchumacher/CoBarSLink.git

Currently the package is configured and tested only for macos (both Apple Silicon and Intel) and with Apple Clang as compiler. The library should compile also with other platforms, provided the correct compiler flags are given. These can be edited in the file LibraryResources/Source/BuildSettings.m. It's some time since we ran this build system under Linux or Windows. So please contact us if you are interested and need support. Also, please contact us if you make this work on other sytems; we would gladly add the configurations into this package.

Usage

From within Mathematica, just run

Get[FileNameJoin[{<<path to cloned repo>>,"CoBarSLink.m"}];

to load the package.

You may also consider to clone directly to the path where Mathematica looks for packages. You can find this path by executing the following line in Mathematica:

FileNameJoin[{$BaseDirectory, "Applications"}]

Then you can load the package just by executing

Needs["CoBarSLink`"];

After loading the package, you get an overview of the most important symbols in the package with

?CoBarSLink`*

To generate samplecount closed random n-gons in dimension d, simply run

d   = 3;
n   = 64;
r   = ConstantArray[1., n];
rho = ConstantArray[1., n];
samplecount = 1000000;
dataCoBarS = RandomClosedPolygons[d, r, samplecount,
    "QuotientSpace" -> True,
    "SphereRadii" -> rho
];

See also the notebook file Example.nb in the Examples subdirection for further usage examples.

Owner

  • Name: HenrikSchumacher
  • Login: HenrikSchumacher
  • Kind: user

Citation (CITATION.cff)

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: CoBarSLink - A Mathematica Interface for CoBarS
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Jason
    family-names: Cantarella
    affiliation: University of Georgia
    orcid: 'https://orcid.org/0000-0002-0613-6131'
  - given-names: Henrik
    family-names: Schumacher
    affiliation: University of Georgia
    orcid: 'https://orcid.org/0000-0002-8700-5570'
repository-code: 'https://github.com/HenrikSchumacher/CoBarSLink'
abstract: >-
  A Mathematica interface for CoBarS, a C++ library for 
  Monte-Carlo sampling of cylic polygons with prescribed 
  edge lengths in any dimension.
license: MIT

GitHub Events

Total
  • Push event: 4
Last Year
  • Push event: 4