syyunn/pinns-playground-tech-stacks

Exhaustive list of technical-stacks to be used to build "Visual-Coding Platform f. the Physics Informed Neural Network"

Fronted

Stateful UI Components

React f. ui-component-wise development

React + Typescript f. strict type checking. Check CRA w. Typescript with this link. React + Typescript complements the loosely typed & error-prone character of vanilla javascript that deteriorates the productivity and clear code sharing in colloabrative developement. Shall include GENERATE_SOURCEMAP=false to the build script so that makes it hard to being reverse-engineered by the 3rd parties.

React-redux f. clean-handling o. state-sharing between components. To understand how global-stroing of local-states could lead to clean-code, check official-example-of-react-redux

testing-library-react f. unittesting. Every stateful components shall be inlcuded as a testing unit. Please consider to move on to airbnb/Enzyme since it's more frequentely maintained.

Styles

Style-baseline

Tachyons f. basic-styles. All styles shall be a superset of this baseline. F. customization, shall use tachyons-css/generator. T. visually understand tachyons, please refer t. tachyons-tldr

Styleguide

Storybook f. isolated-UI-components-development & Component-Driven Development (CDD) & Visual-Test-Driven-Development. Moreover, we'll hightly rely on the addOn(s), one of the core features of the Storybook. For example, to build the responsive UI, we will use Addon-viewport to test the components' compatibility with the expected viewport(s). For the compatibility issue of addOn(s) to the react, please refer to this-link

Testing

Jestas basic testing framework. For react-specific testing convention, follow this-guides. For the core functionalities we are expecting to the Jest, please refer to this link first, rather than official guides.

Visualization

Includes viuslization of dynamic change of weights/bias of NN while on training. For refernce of on-spot visualization while on traning, check tf-playground

Libraries

D3

Observalbes

Data Format (File Extension)

.mat Since physicsts simulates their insight-based inspections using Matlab and produces output in .mat, our primary support of file-extension shall be .mat

.csv Since phsyicists usually shares their experiment(s)-data in .xlsx or csv using Microsoft Excel, we support .csv as our secondary support of file-extension.

Data exchange between python-javascript (Serialization)

In case data being handed over between python and javascript, shall use the fp64 since it's the javascript's primitive-data-type.