Coder Social home page Coder Social logo

eqdes's Introduction

README

This package contains solvers for direct displacement-based design

Major revision at version 0.3.0 - this package is still in alpha.

Function and method naming conventions

  • calc_<property>: A function that calculates a property, if the calculation has multiple different implementations, then include the citation as author and year as well calc_<property>_<author>_<year>
  • design_<system-to-be-designed> A function that implements a design procedure and returns a designed object
  • assess_<system-to-be-designed> A function that implements an assessment procedure and returns a assessed object

Setting up tests

If using PyCharm:
  1. make sure the navigation bar is showing (View>Navigation bar)
  2. Edit Configuration (top right)
  3. Click the plus symbol in the pop up window
  4. Select pytest from the drop down menu
  5. point it to the tests folder
  6. Call the configuration "All tests"

What is this repository for?

  • Quick summary
  • Version

How do I get set up?

  • Summary of set up
  • Configuration
  • Dependencies
  • Database configuration
  • How to run tests
  • Deployment instructions

Contribution guidelines

  • Writing tests
  • Code review
  • Other guidelines

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.