Users can now make use of the Python scripting language to customize, automate, and extend MicroStation functionalities. Python within MicroStation provides access to the most popular, resource rich, and easiest to learn, scripting language available. Users can also make use of the Python Assistant, an AI chat interface, which can work in tandem with users to build custom tools and automations using natural language prompts.
Useful Links
MicroStation Python Assistant (NEW FEATURE: v25.0.0)
- The MicroStation Python Assistant
- Prompt Engineering in the Python Assistant (Prompts. Prompt Engineering)
- Prompt Samples for use in the Python Assistant
Python, Programming & Learning
- MicroStation Programming Forum
- Learning Resources for Python Scripting
- MicroStation Python Blogs/Wikis List
- Using MicroStation Python Samples
- API documentation
- MicroStation GitHub Repository
Why Python?
- An easier to learn scripting language
- A Mature and Supportive Community
- Thousands of publicly available Python Libraries
- A language that offers Versatility, Efficiency, Reliability, and Speed
- A language that is best suited to Big data, Machine Learning and Cloud Computing
- A language that is often first choice language for many programmers and students
- A language that is Open Source
What is the value of this feature?
Users and third-party developers have unique requirements that extend beyond what MicroStation delivers as part of the core features. Users stand to gain several benefits:
- Remove Roadblocks: Increasing the breadth of available tools and automations allows users to increase the number of tasks they complete within MicroStation.
- Maximize adoptability: Python makes an excellent choice for beginners because it uses a simple syntax, comparable to the English language. This can make coding less intimidating for beginners. Python is also supported by a huge community of developers with lots of resources available to help beginners find their footing.
- Improved Productivity: By enabling a great degree of automation and tool creation, users can complete tasks more quickly, saving time and maximizing profitability.
- Win more work: Users can tailor tools to their specific needs or create tools that may not exist giving them the competitive edge over their competitors.
- Increased Footprint: Third Parties can lever a rich community of Python resources, libraries and learning to develop higher impact tools and increase their footprint within the MicroStation community.
- Innovation: Users and third parties can tap into new and innovative uses for the technology they develop by levering a modern, well supported, resource rich language.
- Ecosystem development: Users and third parties can foster the development of an ecosystem of peers, partners and developers who can help them to more effectively develop tools and automations.
How does it work?
MicroStation includes a user interface to manage, run, edit, and seek guidance via the Python assistant for Python scripting. Python serves as an API (Application Programming Interface) to the back end of MicroStation and due of the reasons above, makes the logical choice to make this available, along side VBA, and the software development kit.
How can I learn to use this feature?
The basics of using and developing Python scripts can be found in the MicroStation Help document under the "Python Editor" section via the ribbon. This can also be accessed via the Python Editor in MicroStation.
The other options available from the drop down includes a link to this page, and a link to the API documentation.
How can I learn to script in Python.
Python has become one of the most popular scripting languages available today which means there are no shortage of learning resources available. The Learning Resources for Python Scripting lists some great resources for learn Python scripting.
Learning is all part of a journey and sharing those experiences is a great way to learn from what users have done before. The MicroStation Python Blogs List page outlines blogs about Python.
Observing and using examples scripts also provides a way of learning. MicroStation includes many examples scripts to aid in this learning and is outlined on the Using MicroStation Python Samples page.
And of course, one of the easiest ways of developing your Python skills while being productive, is by using the Python Assistant. Using natural language prompts, users can ask the Assistant to write scripts, ask questions about scripts, ask it to help with debugging, and make use of the Assistant as a mentor.