API Overview
Welcome to the Flux API!
The API allows you to interact with Flux's backend, including the simulator. On this page, you will find all the information you need to get started with the current alpha release.
Prerequisites
In Flux, code is written in JavaScript or Typescript (no worries, we also plan to support other languages like Python in the future).
We hope the Flux API will be easy to use. Where possible, we abstract away the complexities of electronic circuit simulation. However, at least some basic experience with JavaScript/Typescript will be necessary to build Flux models.
If you have no prior experience in programming or web development, there are many free educational resources out there that can help you. Here are just a few of the popular ones:
In addition, many tools used in modern web development will help build more complex projects. You don't need to learn these tools before starting, but they will come in handy eventually. We opted to build on top of the most popular open-source tools in the web development community rather than roll out our proprietary solutions. Here are some examples of things you might end up using:
- TypeScript to make navigating the API more manageable and write robust plugins
- Webpack, to import libraries
Next Steps
- In many cases, you won't need to use the API to run a simulation. Many parts in Flux's library already contain a model you can use immediately. For a few examples, please take a look at our simulator tutorial.
- Before you get started, check out what the current alpha version of the API supports.
- To get right into using the API, here's How the API works.
- If you're already familiar with the API inner workings, you might want to take a stab at the simulator. Happy coding!